Hinting function params, function return value, class attribute using function/class docstrings or PEP-0484 comments.

.travis.yml

@@ -1,7 +1,6 @@
 language: python
 sudo: false
 python:
-  - "2.6"
   - "2.7"
   - "pypy"
   - "3.3"
@@ -11,8 +10,4 @@ matrix:
   allow_failures:
     - python: "pypy"
     - python: "pypy3"
-    - python: "3.3"
-    - python: "3.4"
-before_script:
-  - '[ "${TRAVIS_PYTHON_VERSION}" = "2.6" ] && travis_retry pip install unittest2 || /bin/true'
 script: python setup.py test

CONTRIBUTORS

@@ -2,8 +2,6 @@
  Rope Contributors
 ===================
 
-See Mercurial logs and the mailing list for details.
-
 * Alexander Solovyov <piranha@piranha.org.ua>
 * Sebastjan Trepca <trepca@gmail.com>
 * MATSUI Tetsushi <mft@users.sf.net>
@@ -12,3 +10,5 @@ See Mercurial logs and the mailing list for details.
 * Orestis Markou <orestis@gmail.com>
 * Ronny Pfannschmidt <ronny.pfannschmidt@gmail.com>
 * Anton Gritsay <general@angri.ru>
+* Ivan Zakrevsky <ivzak@yandex.ru>
+* Sergey Glazyrin <sergey.glazyrin.dev@gmail.com>

README.rst

@@ -1,5 +1,5 @@
 
-.. _GitHub python-rope / rope: https://github.com/python-rope/rope
+.. _GitHub python-rope / rope: https://github.com/sergeyglazyrindev/rope
 
 
 ========================================
@@ -11,15 +11,18 @@ Overview
 ========
 
 `Rope`_ is a python refactoring library.
+`Official Rope`_ originally was written by @aligrudi and a long time was supported by @mcepl.
+We hope to give this library fresh breath and new life.
 
-.. _`rope`: https://github.com/python-rope/rope
+.. _`rope`: https://github.com/sergeyglazyrindev/rope
+.. _`Official Rope`: https://github.com/python-rope/rope
 
 
 New Features
 ============
 
-* Under new management! Matěj Cepl <mcepl@cepl.eu> takes it hesitantly
-  over
+* Right now Ivan Zakrevsky and Sergey Glazyrin as emacs fans are
+  working to give the library a new life and support at the same time in a roper package python versions > 2.7
 * Merged all availables pull requests and patches to the main codebase
 * Tests are green again
 
@@ -40,10 +43,9 @@ you open a project).
 Bug Reports
 ===========
 
-Send your bug reports and feature requests to `rope-dev (at)
-googlegroups.com`_.
+Please create issues or enhancements on github `Issues`_ page.
 
-.. _`rope-dev (at) googlegroups.com`: http://groups.google.com/group/rope-dev
+.. _`Issues`: https://github.com/sergeyglazyrindev/rope/issues
 
 
 License
@@ -59,5 +61,5 @@ Have a look at `COPYING`_ for more information.
 .. _`docs/library.rst`: docs/library.html
 .. _`COPYING`: COPYING
 
-.. image:: https://secure.travis-ci.org/python-rope/rope.png
+.. image:: https://secure.travis-ci.org/sergeyglazyrindev/rope.png
    :alt: Build Status

docs/contributing.rst

@@ -14,22 +14,15 @@ welcome to!
 How to Help Rope?
 =================
 
-Rope's mailing list is `rope-dev (at) googlegroups.com`_.  Click the
-"Join group to post" button to subscribe. Then:
+Look into `Issues`_ page and check if you can fix/help/suggest how to fix any issue/enhancement.
 
-* Use rope
-* Send bug reports and request features
-* Submit patches for bugs or new features
-* Discuss your ideas
-
-.. _`rope-dev (at) googlegroups.com`: http://groups.google.com/group/rope-dev
+.. _`Issues`: https://github.com/sergeyglazyrindev/rope/issues
 
 
 Wish List
 =========
 
-You are welcome to send your patches to the `rope-dev (at)
-googlegroups.com`_ mailing list.  Here is a list of suggestions.
+You are welcome to send your patches to this repository Issues page.
 
 Issues
 ------
@@ -38,16 +31,10 @@ The `dev/issues.rst`_ file is actually the main rope todo file.  There
 is a section called "unresolved issues"; it contains almost every kind
 of task.  Most of them need some thought or discussion.  Pickup
 whichever you are most interested in.  If you have ideas or questions
-about them, don't hesitate to discuss it in the mailing list.
+about them, please create corresponding issue and we can discuss enhancements, etc
 
 .. _`dev/issues.rst`: dev/issues.rst
 
-Getting Ready For Python 3.0
-----------------------------
-
-Checkout http://bitbucket.org/agr/rope_py3k Mercurial_ repository.
-Contributions are welcome.
-
 Write Plugins For Other IDEs
 ----------------------------
 
@@ -78,8 +65,7 @@ more information.
 Source Repository
 =================
 
-Rope uses GitHub_. The repository exists at
-`https://github.com/python-rope/rope`_.
+Rope uses GitHub_. The repository exists at https://github.com/sergeyglazyrindev/rope.
 
 
 Submitting patches
@@ -99,9 +85,9 @@ Sending Patches
 ---------------
 
 Follow the instructions on GitHub_ on how to setup Git and fork the
-`python-rope/rope`_ repository. Once your changes are ready, send a
+`sergeyglazyrindev/rope`_ repository. Once your changes are ready, send a
 `pull request`_ for review.
 
 .. _GitHub: http://github.com/
-.. _`python-rope/rope`: https://github.com/python-rope/rope
+.. _`sergeyglazyrindev/rope`: https://github.com/sergeyglazyrindev/rope
 .. _`pull request`: https://help.github.com/articles/using-pull-requests

docs/overview.rst

@@ -737,8 +737,7 @@ examples.  After this example you might like to have a look at:
   default wildcard supports.
 
 Finally, restructurings can be improved in many ways (for instance
-adding new wildcards).  You might like to discuss your ideas in the
-mailing list.
+adding new wildcards). 
 
 
 Example 1
@@ -1209,6 +1208,98 @@ Rope uses this feature by default but you can disable it by editing
 ``config.py``.
 
 
+Type Hinting
+------------
+
+Currently supported type hinting for:
+
+- function parameter type, using function doctring (:type or @type)
+- function return type, using function doctring (:rtype or @rtype)
+- class attribute type, using class docstring (:type or @type). Attribute should by set to None or NotImplemented in class or constructor of class.
+- any assignment, using type comments of PEP 0484 (in limited form).
+
+If rope cannot detect the type of a function argument correctly (due to the
+dynamic nature of Python), you can help it by hinting the type using
+one of the following docstring syntax styles.
+
+
+**Sphinx style**
+
+http://sphinx-doc.org/domains.html#info-field-lists
+
+::
+
+    def myfunction(node, foo):
+        """Do something with a ``node``.
+
+        :type node: ProgramNode
+        :param str foo: foo parameter description
+
+        """
+        node.| # complete here
+
+
+**Epydoc**
+
+http://epydoc.sourceforge.net/manual-fields.html
+
+::
+
+    def myfunction(node):
+        """Do something with a ``node``.
+
+        @type node: ProgramNode
+
+        """
+        node.| # complete here
+
+
+**Numpydoc**
+
+https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
+
+In order to support the numpydoc format, you need to install the `numpydoc
+<https://pypi.python.org/pypi/numpydoc>`__ package.
+
+::
+
+    def foo(var1, var2, long_var_name='hi'):
+        r"""A one-line summary that does not use variable names or the
+        function name.
+
+        ...
+
+        Parameters
+        ----------
+        var1 : array_like
+            Array_like means all those objects -- lists, nested lists,
+            etc. -- that can be converted to an array. We can also
+            refer to variables like `var1`.
+        var2 : int
+            The type above can either refer to an actual Python type
+            (e.g. ``int``), or describe the type of the variable in more
+            detail, e.g. ``(N,) ndarray`` or ``array_like``.
+        long_variable_name : {'hi', 'ho'}, optional
+            Choices in brackets, default first when optional.
+
+        ...
+
+        """
+        var2.| # complete here
+
+
+**PEP 0484**
+
+https://www.python.org/dev/peps/pep-0484/#type-comments
+
+::
+
+   class Sample(object):
+       def __init__(self):
+           self.x = None  # type: random.Random
+           self.x.| # complete here
+
+
 Custom Source Folders
 =====================
 

docs/rope.rst

@@ -44,6 +44,7 @@ Features implemented so far:
   * Static and dynamic object analysis
   * Handling built-in container types
   * Saving object information on disk and validating them
+  * Type hints using docstring or type comments PEP 0484
 
 For more information see `overview.rst`_.
 

rope/base/astutils.py

@@ -40,6 +40,9 @@ def _added(self, node, levels):
     def _Name(self, node):
         self._add_node(node)
 
+    def _ExceptHandler(self, node):
+        self.names.append((node.name, []))
+
     def _Tuple(self, node):
         new_levels = []
         if self.levels is not None:

rope/base/builtins.py

@@ -6,7 +6,8 @@
     raw_input = input
 
 import rope.base.evaluate
-from rope.base import pynames, pyobjects, arguments, utils, ast
+from rope.base.utils import pycompat
+from rope.base import pynames, pyobjects, arguments, utils
 
 
 class BuiltinModule(pyobjects.AbstractModule):
@@ -271,7 +272,7 @@ def __init__(self, holding=None):
         collector('__getitem__', function=self._list_get)
         collector('pop', function=self._list_get)
         try:
-            collector('__getslice__', function=self._self_get)
+            collector('__getslice__', function=self._list_get)
         except AttributeError:
             pass
 
@@ -297,6 +298,10 @@ def _self_set(self, context):
 
     def _list_get(self, context):
         if self.holding is not None:
+            args = context.get_arguments(['self', 'key'])
+            if (len(args) > 1 and args[1] is not None and
+                    args[1].get_type() == builtins['slice'].get_object()):
+                return get_list(self.holding)
             return self.holding
         return context.get_per_name()
 
@@ -414,7 +419,7 @@ def __init__(self, *objects):
         if objects:
             first = objects[0]
         attributes = {
-            '__getitem__': BuiltinName(BuiltinFunction(first)),
+            '__getitem__': BuiltinName(BuiltinFunction(first)),  # TODO: add slice support
             '__getslice__':
             BuiltinName(BuiltinFunction(pyobjects.PyObject(self))),
             '__new__': BuiltinName(BuiltinFunction(function=self._new_tuple)),
@@ -656,12 +661,12 @@ def get_name(self):
         return 'lambda'
 
     def get_param_names(self, special_args=True):
-        result = [node.id for node in self.arguments.args
-                  if isinstance(node, ast.Name)]
+        result = [pycompat.get_ast_arg_arg(node) for node in self.arguments.args
+                  if isinstance(node, pycompat.ast_arg_type)]
         if self.arguments.vararg:
-            result.append('*' + self.arguments.vararg)
+            result.append('*' + pycompat.get_ast_arg_arg(self.arguments.vararg))
         if self.arguments.kwarg:
-            result.append('**' + self.arguments.kwarg)
+            result.append('**' + pycompat.get_ast_arg_arg(self.arguments.kwarg))
         return result
 
     @property
@@ -801,4 +806,4 @@ def _input_function(args):
                              builtin=raw_input)),
 }
 
-builtins = BuiltinModule('__builtin__', initial=_initial_builtins)
+builtins = BuiltinModule(pycompat.builtins.__name__, initial=_initial_builtins)

rope/base/evaluate.py

@@ -2,6 +2,7 @@
 import rope.base.pynames
 import rope.base.pyobjects
 from rope.base import ast, astutils, exceptions, pyobjects, arguments, worder
+from rope.base.utils import pycompat
 
 
 BadIdentifierError = exceptions.BadIdentifierError
@@ -290,7 +291,11 @@ def _Subscript(self, node):
             self._call_function(node.value, '__getitem__',
                                 [node.slice.value])
         elif isinstance(node.slice, ast.Slice):
-            self._call_function(node.value, '__getslice__')
+            self._call_function(node.value, '__getitem__',
+                                [node.slice])
+
+    def _Slice(self, node):
+        self.result = self._get_builtin_name('slice')
 
     def _call_function(self, node, function_name, other_args=None):
         pyname = eval_node(self.scope, node)