add pt2tf tool

2020-09-23 09:09:49 +08:00
parent 7f7b7df65d
commit 18aefa4dd0
407 changed files with 16211 additions and 0 deletions
@@ -0,0 +1,110 @@
+# Copyright 2015: Mirantis Inc.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import re
+import sys
+
+PARAM_OR_RETURNS_REGEX = re.compile(":(?:param|returns)")
+RETURNS_REGEX = re.compile(":returns: (?P<doc>.*)", re.S)
+PARAM_REGEX = re.compile(":param (?P<name>[\*\w]+): (?P<doc>.*?)"
+                         "(?:(?=:param)|(?=:return)|(?=:raises)|\Z)", re.S)
+
+
+def trim(docstring):
+    """trim function from PEP-257"""
+    if not docstring:
+        return ""
+    # Convert tabs to spaces (following the normal Python rules)
+    # and split into a list of lines:
+    lines = docstring.expandtabs().splitlines()
+    # Determine minimum indentation (first line doesn't count):
+    indent = sys.maxsize
+    for line in lines[1:]:
+        stripped = line.lstrip()
+        if stripped:
+            indent = min(indent, len(line) - len(stripped))
+    # Remove indentation (first line is special):
+    trimmed = [lines[0].strip()]
+    if indent < sys.maxsize:
+        for line in lines[1:]:
+            trimmed.append(line[indent:].rstrip())
+    # Strip off trailing and leading blank lines:
+    while trimmed and not trimmed[-1]:
+        trimmed.pop()
+    while trimmed and not trimmed[0]:
+        trimmed.pop(0)
+
+    # Current code/unittests expects a line return at
+    # end of multiline docstrings
+    # workaround expected behavior from unittests
+    if "\n" in docstring:
+        trimmed.append("")
+
+    # Return a single string:
+    return "\n".join(trimmed)
+
+
+def reindent(string):
+    return "\n".join(l.strip() for l in string.strip().split("\n"))
+
+
+def parse_docstring(docstring):
+    """Parse the docstring into its components.
+
+    :returns: a dictionary of form
+              {
+                  "short_description": ...,
+                  "long_description": ...,
+                  "params": [{"name": ..., "doc": ...}, ...],
+                  "returns": ...
+              }
+    """
+
+    short_description = long_description = returns = ""
+    params = []
+
+    if docstring:
+        docstring = trim(docstring)
+
+        lines = docstring.split("\n", 1)
+        short_description = lines[0]
+
+        if len(lines) > 1:
+            long_description = lines[1].strip()
+
+            params_returns_desc = None
+
+            match = PARAM_OR_RETURNS_REGEX.search(long_description)
+            if match:
+                long_desc_end = match.start()
+                params_returns_desc = long_description[long_desc_end:].strip()
+                long_description = long_description[:long_desc_end].rstrip()
+
+            if params_returns_desc:
+                params = [
+                    {"name": name, "doc": trim(doc)}
+                    for name, doc in PARAM_REGEX.findall(params_returns_desc)
+                ]
+
+                match = RETURNS_REGEX.search(params_returns_desc)
+                if match:
+                    returns = reindent(match.group("doc"))
+
+    return {
+        "short_description": short_description,
+        "long_description": long_description,
+        "params": params,
+        "returns": returns
+    }