Merge pull request #473 from bageljrkhanofemus/toml

use pytoolconfig for configuration

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 # New feature
 
+- #473 Pyproject.toml support (@bageljrkhanofemus)
 - #489 Rope now publishes documentations to readthedocs.org (@bageljrkhanofemus)
 - #490 Migrate from setup.py to pyproject.toml (@bageljrkhanofemus)
 

docs/configuration.rst

@@ -42,10 +42,17 @@ Additionally, you can run an executable function at startup of rope.
     def project_opened(project):
         """This function is called after opening the project"""
         # Do whatever you like here!
- 
 
-..
-    Options
-    -------
-    .. autopytoolconfigtable:: rope.base.prefs.Prefs
 
+
+
+Options
+-------
+.. autopytoolconfigtable:: rope.base.prefs.Prefs
+
+Old Configuration File
+----------------------
+This is a sample config.py. While this config.py works and all options here should be supported, the above documentation reflects the latest version of rope.
+
+.. literalinclude:: default_config.py  
+   :language: python3

rope/base/default_config.py → docs/default_config.py

@@ -9,104 +9,125 @@ def set_prefs(prefs):
     # Changes to ignored resources are not added to the history and
     # VCSs.  Also they are not returned in `Project.get_files()`.
     # Note that ``?`` and ``*`` match all characters but slashes.
-    # '*.pyc': matches 'test.pyc' and 'pkg/test.pyc'
-    # 'mod*.pyc': matches 'test/mod1.pyc' but not 'mod/1.pyc'
-    # '.svn': matches 'pkg/.svn' and all of its children
-    # 'build/*.o': matches 'build/lib.o' but not 'build/sub/lib.o'
-    # 'build//*.o': matches 'build/lib.o' and 'build/sub/lib.o'
-    prefs["ignored_resources"] = [
-        "*.pyc",
-        "*~",
-        ".ropeproject",
-        ".hg",
-        ".svn",
-        "_svn",
-        ".git",
-        ".tox",
-        ".venv",
-        "venv",
-    ]
+    # "*.pyc": matches "test.pyc" and "pkg/test.pyc"
+    # "mod*.pyc": matches "test/mod1.pyc" but not "mod/1.pyc"
+    # ".svn": matches "pkg/.svn" and all of its children
+    # "build/*.o": matches "build/lib.o" but not "build/sub/lib.o"
+    # "build//*.o": matches "build/lib.o" and "build/sub/lib.o"
+    #
+    #    prefs["ignored_resources"] = [
+    #        "*.pyc",
+    #        "*~",
+    #        ".ropeproject",
+    #        ".hg",
+    #        ".svn",
+    #        "_svn",
+    #        ".git",
+    #        ".tox",
+    #        ".venv",
+    #        "venv",
+    #    ]
 
     # Specifies which files should be considered python files.  It is
     # useful when you have scripts inside your project.  Only files
     # ending with ``.py`` are considered to be python files by
     # default.
-    # prefs['python_files'] = ['*.py']
+    #
+    #     prefs["python_files"] = ["*.py"]
 
     # Custom source folders:  By default rope searches the project
     # for finding source folders (folders that should be searched
     # for finding modules).  You can add paths to that list.  Note
     # that rope guesses project source folders correctly most of the
     # time; use this if you have any problems.
-    # The folders should be relative to project root and use '/' for
+    # The folders should be relative to project root and use "/" for
     # separating folders regardless of the platform rope is running on.
-    # 'src/my_source_folder' for instance.
-    # prefs.add('source_folders', 'src')
+    # "src/my_source_folder" for instance.
+    #
+    #     prefs.add("source_folders", "src")
 
     # You can extend python path for looking up modules
-    # prefs.add('python_path', '~/python/')
+    #
+    #     prefs.add("python_path", "~/python/")
 
     # Should rope save object information or not.
-    prefs["save_objectdb"] = True
-    prefs["compress_objectdb"] = False
+    #
+    #     prefs["save_objectdb"] = True
+    #     prefs["compress_objectdb"] = False
 
     # If `True`, rope analyzes each module when it is being saved.
-    prefs["automatic_soa"] = True
+    #
+    #     prefs["automatic_soa"] = True
+    #
     # The depth of calls to follow in static object analysis
-    prefs["soa_followed_calls"] = 0
+    #
+    #     prefs["soa_followed_calls"] = 0
 
     # If `False` when running modules or unit tests "dynamic object
     # analysis" is turned off.  This makes them much faster.
-    prefs["perform_doa"] = True
+    #
+    #     prefs["perform_doa"] = True
 
     # Rope can check the validity of its object DB when running.
-    prefs["validate_objectdb"] = True
+    #
+    #    prefs["validate_objectdb"] = True
 
     # How many undos to hold?
-    prefs["max_history_items"] = 32
+    #
+    #     prefs["max_history_items"] = 32
 
     # Shows whether to save history across sessions.
-    prefs["save_history"] = True
-    prefs["compress_history"] = False
+    #
+    #     prefs["save_history"] = True
+    #     prefs["compress_history"] = False
 
     # Set the number spaces used for indenting.  According to
     # :PEP:`8`, it is best to use 4 spaces.  Since most of rope's
     # unit-tests use 4 spaces it is more reliable, too.
-    prefs["indent_size"] = 4
+    #
+    #     prefs["indent_size"] = 4
 
     # Builtin and c-extension modules that are allowed to be imported
     # and inspected by rope.
-    prefs["extension_modules"] = []
+    #
+    #     prefs["extension_modules"] = []
 
     # Add all standard c-extensions to extension_modules list.
-    prefs["import_dynload_stdmods"] = True
+    #
+    #     prefs["import_dynload_stdmods"] = True
 
     # If `True` modules with syntax errors are considered to be empty.
     # The default value is `False`; When `False` syntax errors raise
     # `rope.base.exceptions.ModuleSyntaxError` exception.
-    prefs["ignore_syntax_errors"] = False
+    #
+    #     prefs["ignore_syntax_errors"] = False
 
     # If `True`, rope ignores unresolvable imports.  Otherwise, they
     # appear in the importing namespace.
-    prefs["ignore_bad_imports"] = False
+    #
+    #     prefs["ignore_bad_imports"] = False
 
     # If `True`, rope will insert new module imports as
     # `from <package> import <module>` by default.
-    prefs["prefer_module_from_imports"] = False
+    #
+    #     prefs["prefer_module_from_imports"] = False
 
     # If `True`, rope will transform a comma list of imports into
     # multiple separate import statements when organizing
     # imports.
-    prefs["split_imports"] = False
+    #
+    #     prefs["split_imports"] = False
 
     # If `True`, rope will remove all top-level import statements and
     # reinsert them at the top of the module when making changes.
-    prefs["pull_imports_to_top"] = True
+    #
+    #     prefs["pull_imports_to_top"] = True
 
     # If `True`, rope will sort imports alphabetically by module name instead
     # of alphabetically by import statement, with from imports after normal
     # imports.
-    prefs["sort_imports_alphabetically"] = False
+    #
+    #     prefs["sort_imports_alphabetically"] = False
 
     # Location of implementation of
     # rope.base.oi.type_hinting.interfaces.ITypeHintingFactory In general
@@ -115,9 +136,10 @@ def set_prefs(prefs):
     # listed in module rope.base.oi.type_hinting.providers.interfaces
     # For example, you can add you own providers for Django Models, or disable
     # the search type-hinting in a class hierarchy, etc.
-    prefs[
-        "type_hinting_factory"
-    ] = "rope.base.oi.type_hinting.factory.default_type_hinting_factory"
+    #
+    #     prefs[
+    #         "type_hinting_factory"
+    #     ] = "rope.base.oi.type_hinting.factory.default_type_hinting_factory"
 
 
 def project_opened(project):