VimPlug/parso
1
0
Fork 0
mirror of https://github.com/davidhalter/parso.git synced 2025-12-07 05:14:29 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

More tree docstrings.

Browse Source
This commit is contained in:
Dave Halter
2017-09-04 21:58:48 +02:00
parent 82868580a2
commit dcdd3bbc8e
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
parso/python/tree.py
View File

@@ -96,6 +96,10 @@ class PythonMixin(object):
__slots__ = () __slots__ = ()
def get_name_of_position(self, position): def get_name_of_position(self, position):
"""
Given a (line, column) tuple, returns a :class`Name` or ``None`` if
there is no name at that position.
"""
for c in self.children: for c in self.children:
if isinstance(c, Leaf): if isinstance(c, Leaf):
if c.type == 'name' and c.start_pos <= position <= c.end_pos: if c.type == 'name' and c.start_pos <= position <= c.end_pos:
@@ -114,6 +118,9 @@ class PythonLeaf(PythonMixin, Leaf):
return split_prefix(self, self.get_start_pos_of_prefix()) return split_prefix(self, self.get_start_pos_of_prefix())
def get_start_pos_of_prefix(self): def get_start_pos_of_prefix(self):
"""
Basically calls :py:meth:`parso.tree.NodeOrLeaf.get_start_pos_of_prefix`.
"""
# TODO it is really ugly that we have to override it. Maybe change # TODO it is really ugly that we have to override it. Maybe change
# indent error leafs somehow? No idea how, though. # indent error leafs somehow? No idea how, though.
previous_leaf = self.get_previous_leaf() previous_leaf = self.get_previous_leaf()
@@ -360,7 +367,8 @@ class Module(Scope):
def _iter_future_import_names(self): def _iter_future_import_names(self):
""" """
:return list of str: A list of future import names. :return: A list of future import names.
:rtype: list of str
""" """
# In Python it's not allowed to use future imports after the first # In Python it's not allowed to use future imports after the first
# actual (non-future) statement. However this is not a linter here, # actual (non-future) statement. However this is not a linter here,
@@ -387,8 +395,8 @@ class Module(Scope):
def get_used_names(self): def get_used_names(self):
""" """
Returns all the `Name` leafs that exist in this module. Tihs includes Returns all the :class:`Name` leafs that exist in this module. This
both definitions and references of names. includes both definitions and references of names.
""" """
if self._used_names is None: if self._used_names is None:
# Don't directly use self._used_names to eliminate a lookup. # Don't directly use self._used_names to eliminate a lookup.
@@ -427,7 +435,7 @@ class ClassOrFunc(Scope):
def get_decorators(self): def get_decorators(self):
""" """
:return list of Decorator: :rtype: list of :class:`Decorator`
""" """
decorated = self.parent decorated = self.parent
if decorated.type == 'decorated': if decorated.type == 'decorated':
@@ -442,13 +450,6 @@ class ClassOrFunc(Scope):
class Class(ClassOrFunc): class Class(ClassOrFunc):
""" """
Used to store the parsed contents of a python class. Used to store the parsed contents of a python class.
:param name: The Class name.
:type name: str
:param supers: The super classes of a Class.
:type supers: list
:param start_pos: The start position (line, column) of the class.
:type start_pos: tuple(int, int)
""" """
type = 'classdef' type = 'classdef'
__slots__ = () __slots__ = ()