debugpy 1.8.5__zip → 1.8.7__zip

{debugpy-1.8.5 → debugpy-1.8.7}/src/debugpy/_vendored/pydevd/_pydev_bundle/_pydev_imports_tipper.py

@@ -14,28 +14,28 @@ def getargspec(*args, **kwargs):
 
 
 # completion types.
-TYPE_IMPORT = '0'
-TYPE_CLASS = '1'
-TYPE_FUNCTION = '2'
-TYPE_ATTR = '3'
-TYPE_BUILTIN = '4'
-TYPE_PARAM = '5'
+TYPE_IMPORT = "0"
+TYPE_CLASS = "1"
+TYPE_FUNCTION = "2"
+TYPE_ATTR = "3"
+TYPE_BUILTIN = "4"
+TYPE_PARAM = "5"
 
 
 def _imp(name, log=None):
     try:
         return __import__(name)
     except:
-        if '.' in name:
-            sub = name[0:name.rfind('.')]
+        if "." in name:
+            sub = name[0 : name.rfind(".")]
 
             if log is not None:
-                log.add_content('Unable to import', name, 'trying with', sub)
+                log.add_content("Unable to import", name, "trying with", sub)
                 log.add_exception()
 
             return _imp(sub, log)
         else:
-            s = 'Unable to import module: %s - sys.path: %s' % (str(name), sys.path)
+            s = "Unable to import module: %s - sys.path: %s" % (str(name), sys.path)
             if log is not None:
                 log.add_content(s)
                 log.add_exception()
@@ -44,20 +44,21 @@ def _imp(name, log=None):
 
 
 IS_IPY = False
-if sys.platform == 'cli':
+if sys.platform == "cli":
     IS_IPY = True
     _old_imp = _imp
 
     def _imp(name, log=None):
         # We must add a reference in clr for .Net
         import clr  # @UnresolvedImport
+
         initial_name = name
-        while '.' in name:
+        while "." in name:
             try:
                 clr.AddReference(name)
                 break  # If it worked, that's OK.
             except:
-                name = name[0:name.rfind('.')]
+                name = name[0 : name.rfind(".")]
         else:
             try:
                 clr.AddReference(name)
@@ -73,11 +74,11 @@ def get_file(mod):
         f = inspect.getsourcefile(mod) or inspect.getfile(mod)
     except:
         try:
-            f = getattr(mod, '__file__', None)
+            f = getattr(mod, "__file__", None)
         except:
             f = None
-        if f and f.lower(f[-4:]) in ['.pyc', '.pyo']:
-            filename = f[:-4] + '.py'
+        if f and f.lower(f[-4:]) in [".pyc", ".pyo"]:
+            filename = f[:-4] + ".py"
             if os.path.exists(filename):
                 f = filename
 
@@ -89,12 +90,12 @@ def Find(name, log=None):
 
     mod = _imp(name, log)
     parent = mod
-    foundAs = ''
+    foundAs = ""
 
     if inspect.ismodule(mod):
         f = get_file(mod)
 
-    components = name.split('.')
+    components = name.split(".")
 
     old_comp = None
     for comp in components[1:]:
@@ -111,7 +112,7 @@ def Find(name, log=None):
             f = get_file(mod)
         else:
             if len(foundAs) > 0:
-                foundAs = foundAs + '.'
+                foundAs = foundAs + "."
             foundAs = foundAs + comp
 
         old_comp = comp
@@ -120,12 +121,11 @@ def Find(name, log=None):
 
 
 def search_definition(data):
-    '''@return file, line, col
-    '''
+    """@return file, line, col"""
 
-    data = data.replace('\n', '')
-    if data.endswith('.'):
-        data = data.rstrip('.')
+    data = data.replace("\n", "")
+    if data.endswith("."):
+        data = data.rstrip(".")
     f, mod, parent, foundAs = Find(data)
     try:
         return do_find(f, mod), foundAs
@@ -134,9 +134,9 @@ def search_definition(data):
 
 
 def generate_tip(data, log=None):
-    data = data.replace('\n', '')
-    if data.endswith('.'):
-        data = data.rstrip('.')
+    data = data.replace("\n", "")
+    if data.endswith("."):
+        data = data.rstrip(".")
 
     f, mod, parent, foundAs = Find(data, log)
     # print_ >> open('temp.txt', 'w'), f
@@ -145,31 +145,31 @@ def generate_tip(data, log=None):
 
 
 def check_char(c):
-    if c == '-' or c == '.':
-        return '_'
+    if c == "-" or c == ".":
+        return "_"
     return c
 
 
 _SENTINEL = object()
 
 
-def generate_imports_tip_for_module(obj_to_complete, dir_comps=None, getattr=getattr, filter=lambda name:True):
-    '''
-        @param obj_to_complete: the object from where we should get the completions
-        @param dir_comps: if passed, we should not 'dir' the object and should just iterate those passed as kwonly_arg parameter
-        @param getattr: the way to get kwonly_arg given object from the obj_to_complete (used for the completer)
-        @param filter: kwonly_arg callable that receives the name and decides if it should be appended or not to the results
-        @return: list of tuples, so that each tuple represents kwonly_arg completion with:
-            name, doc, args, type (from the TYPE_* constants)
-    '''
+def generate_imports_tip_for_module(obj_to_complete, dir_comps=None, getattr=getattr, filter=lambda name: True):
+    """
+    @param obj_to_complete: the object from where we should get the completions
+    @param dir_comps: if passed, we should not 'dir' the object and should just iterate those passed as kwonly_arg parameter
+    @param getattr: the way to get kwonly_arg given object from the obj_to_complete (used for the completer)
+    @param filter: kwonly_arg callable that receives the name and decides if it should be appended or not to the results
+    @return: list of tuples, so that each tuple represents kwonly_arg completion with:
+        name, doc, args, type (from the TYPE_* constants)
+    """
     ret = []
 
     if dir_comps is None:
         dir_comps = dir_checked(obj_to_complete)
-        if hasattr_checked(obj_to_complete, '__dict__'):
-            dir_comps.append('__dict__')
-        if hasattr_checked(obj_to_complete, '__class__'):
-            dir_comps.append('__class__')
+        if hasattr_checked(obj_to_complete, "__dict__"):
+            dir_comps.append("__dict__")
+        if hasattr_checked(obj_to_complete, "__class__"):
+            dir_comps.append("__class__")
 
     get_complete_info = True
 
@@ -182,31 +182,31 @@ def generate_imports_tip_for_module(obj_to_complete, dir_comps=None, getattr=get
     dontGetDocsOn = (float, int, str, tuple, list, dict)
     dontGetattrOn = (dict, list, set, tuple)
     for d in dir_comps:
-
         if d is None:
             continue
 
         if not filter(d):
             continue
 
-        args = ''
+        args = ""
 
         try:
             try:
                 if isinstance(obj_to_complete, dontGetattrOn):
-                    raise Exception('Since python 3.9, e.g. "dict[str]" will return'
-                                    " a dict that's only supposed to take strings. "
-                                    'Interestingly, e.g. dict["val"] is also valid '
-                                    'and presumably represents a dict that only takes '
-                                    'keys that are "val". This breaks our check for '
-                                    'class attributes.')
+                    raise Exception(
+                        'Since python 3.9, e.g. "dict[str]" will return'
+                        " a dict that's only supposed to take strings. "
+                        'Interestingly, e.g. dict["val"] is also valid '
+                        "and presumably represents a dict that only takes "
+                        'keys that are "val". This breaks our check for '
+                        "class attributes."
+                    )
                 obj = getattr(obj_to_complete.__class__, d)
             except:
                 obj = getattr(obj_to_complete, d)
         except:  # just ignore and get it without additional info
-            ret.append((d, '', args, TYPE_BUILTIN))
+            ret.append((d, "", args, TYPE_BUILTIN))
         else:
-
             if get_complete_info:
                 try:
                     retType = TYPE_BUILTIN
@@ -214,21 +214,20 @@ def generate_imports_tip_for_module(obj_to_complete, dir_comps=None, getattr=get
                     # check if we have to get docs
                     getDoc = True
                     for class_ in dontGetDocsOn:
-
                         if isinstance(obj, class_):
                             getDoc = False
                             break
 
-                    doc = ''
+                    doc = ""
                     if getDoc:
                         # no need to get this info... too many constants are defined and
                         # makes things much slower (passing all that through sockets takes quite some time)
                         try:
                             doc = inspect.getdoc(obj)
                             if doc is None:
-                                doc = ''
+                                doc = ""
                         except:  # may happen on jython when checking java classes (so, just ignore it)
-                            doc = ''
+                            doc = ""
 
                     if inspect.ismethod(obj) or inspect.isbuiltin(obj) or inspect.isfunction(obj) or inspect.isroutine(obj):
                         try:
@@ -239,14 +238,14 @@ def generate_imports_tip_for_module(obj_to_complete, dir_comps=None, getattr=get
                             for kwonly_arg in kwonly_args:
                                 default = kwonly_defaults.get(kwonly_arg, _SENTINEL)
                                 if default is not _SENTINEL:
-                                    args.append('%s=%s' % (kwonly_arg, default))
+                                    args.append("%s=%s" % (kwonly_arg, default))
                                 else:
                                     args.append(str(kwonly_arg))
 
-                            args = '(%s)' % (', '.join(args))
+                            args = "(%s)" % (", ".join(args))
                         except TypeError:
                             # ok, let's see if we can get the arguments from the doc
-                            args, doc = signature_from_docstring(doc, getattr(obj, '__name__', None))
+                            args, doc = signature_from_docstring(doc, getattr(obj, "__name__", None))
 
                         retType = TYPE_FUNCTION
 
@@ -263,7 +262,7 @@ def generate_imports_tip_for_module(obj_to_complete, dir_comps=None, getattr=get
                     ret.append((d, doc, args, retType))
 
                 except:  # just ignore and get it without aditional info
-                    ret.append((d, '', args, TYPE_BUILTIN))
+                    ret.append((d, "", args, TYPE_BUILTIN))
 
             else:  # get_complete_info == False
                 if inspect.ismethod(obj) or inspect.isbuiltin(obj) or inspect.isfunction(obj) or inspect.isroutine(obj):
@@ -279,13 +278,13 @@ def generate_imports_tip_for_module(obj_to_complete, dir_comps=None, getattr=get
                     retType = TYPE_ATTR
                 # ok, no complete info, let's try to do this as fast and clean as possible
                 # so, no docs for this kind of information, only the signatures
-                ret.append((d, '', str(args), retType))
+                ret.append((d, "", str(args), retType))
 
     return ret
 
 
 def signature_from_docstring(doc, obj_name):
-    args = '()'
+    args = "()"
     try:
         found = False
         if len(doc) > 0:
@@ -301,50 +300,50 @@ def signature_from_docstring(doc, obj_name):
                 # sort(self: list)
                 # sort(self: list, cmp: object)
                 if obj_name:
-                    name = obj_name + '('
+                    name = obj_name + "("
 
                     # Fix issue where it was appearing sort(aa)sort(bb)sort(cc) in the same line.
                     lines = doc.splitlines()
                     if len(lines) == 1:
                         c = doc.count(name)
                         if c > 1:
-                            doc = ('\n' + name).join(doc.split(name))
+                            doc = ("\n" + name).join(doc.split(name))
 
-                    major = ''
+                    major = ""
                     for line in doc.splitlines():
-                        if line.startswith(name) and line.endswith(')'):
+                        if line.startswith(name) and line.endswith(")"):
                             if len(line) > len(major):
                                 major = line
                     if major:
-                        args = major[major.index('('):]
+                        args = major[major.index("(") :]
                         found = True
 
             if not found:
-                i = doc.find('->')
+                i = doc.find("->")
                 if i < 0:
-                    i = doc.find('--')
+                    i = doc.find("--")
                     if i < 0:
-                        i = doc.find('\n')
+                        i = doc.find("\n")
                         if i < 0:
-                            i = doc.find('\r')
+                            i = doc.find("\r")
 
                 if i > 0:
                     s = doc[0:i]
                     s = s.strip()
 
                     # let's see if we have a docstring in the first line
-                    if s[-1] == ')':
-                        start = s.find('(')
+                    if s[-1] == ")":
+                        start = s.find("(")
                         if start >= 0:
-                            end = s.find('[')
+                            end = s.find("[")
                             if end <= 0:
-                                end = s.find(')')
+                                end = s.find(")")
                                 if end <= 0:
                                     end = len(s)
 
                             args = s[start:end]
-                            if not args[-1] == ')':
-                                args = args + ')'
+                            if not args[-1] == ")":
+                                args = args + ")"
 
                             # now, get rid of unwanted chars
                             l = len(args) - 1
@@ -355,18 +354,18 @@ def signature_from_docstring(doc, obj_name):
                                 else:
                                     r.append(check_char(args[i]))
 
-                            args = ''.join(r)
+                            args = "".join(r)
 
             if IS_IPY:
-                if args.startswith('(self:'):
-                    i = args.find(',')
+                if args.startswith("(self:"):
+                    i = args.find(",")
                     if i >= 0:
-                        args = '(self' + args[i:]
+                        args = "(self" + args[i:]
                     else:
-                        args = '(self)'
-                i = args.find(')')
+                        args = "(self)"
+                i = args.find(")")
                 if i > 0:
-                    args = args[:i + 1]
+                    args = args[: i + 1]
 
     except:
         pass