|
| 1 | +# The default ``config.py`` |
| 2 | +# flake8: noqa |
| 3 | + |
| 4 | + |
| 5 | +def set_prefs(prefs): |
| 6 | + """This function is called before opening the project""" |
| 7 | + |
| 8 | + # Specify which files and folders to ignore in the project. |
| 9 | + # Changes to ignored resources are not added to the history and |
| 10 | + # VCSs. Also they are not returned in `Project.get_files()`. |
| 11 | + # Note that ``?`` and ``*`` match all characters but slashes. |
| 12 | + # '*.pyc': matches 'test.pyc' and 'pkg/test.pyc' |
| 13 | + # 'mod*.pyc': matches 'test/mod1.pyc' but not 'mod/1.pyc' |
| 14 | + # '.svn': matches 'pkg/.svn' and all of its children |
| 15 | + # 'build/*.o': matches 'build/lib.o' but not 'build/sub/lib.o' |
| 16 | + # 'build//*.o': matches 'build/lib.o' and 'build/sub/lib.o' |
| 17 | + prefs["ignored_resources"] = [ |
| 18 | + "*.pyc", |
| 19 | + "*~", |
| 20 | + ".ropeproject", |
| 21 | + ".hg", |
| 22 | + ".svn", |
| 23 | + "_svn", |
| 24 | + ".git", |
| 25 | + ".tox", |
| 26 | + ] |
| 27 | + |
| 28 | + # Specifies which files should be considered python files. It is |
| 29 | + # useful when you have scripts inside your project. Only files |
| 30 | + # ending with ``.py`` are considered to be python files by |
| 31 | + # default. |
| 32 | + # prefs['python_files'] = ['*.py'] |
| 33 | + |
| 34 | + # Custom source folders: By default rope searches the project |
| 35 | + # for finding source folders (folders that should be searched |
| 36 | + # for finding modules). You can add paths to that list. Note |
| 37 | + # that rope guesses project source folders correctly most of the |
| 38 | + # time; use this if you have any problems. |
| 39 | + # The folders should be relative to project root and use '/' for |
| 40 | + # separating folders regardless of the platform rope is running on. |
| 41 | + # 'src/my_source_folder' for instance. |
| 42 | + # prefs.add('source_folders', 'src') |
| 43 | + |
| 44 | + # You can extend python path for looking up modules |
| 45 | + # prefs.add('python_path', '~/python/') |
| 46 | + |
| 47 | + # Should rope save object information or not. |
| 48 | + prefs["save_objectdb"] = True |
| 49 | + prefs["compress_objectdb"] = False |
| 50 | + |
| 51 | + # If `True`, rope analyzes each module when it is being saved. |
| 52 | + prefs["automatic_soa"] = True |
| 53 | + # The depth of calls to follow in static object analysis |
| 54 | + prefs["soa_followed_calls"] = 0 |
| 55 | + |
| 56 | + # If `False` when running modules or unit tests "dynamic object |
| 57 | + # analysis" is turned off. This makes them much faster. |
| 58 | + prefs["perform_doa"] = True |
| 59 | + |
| 60 | + # Rope can check the validity of its object DB when running. |
| 61 | + prefs["validate_objectdb"] = True |
| 62 | + |
| 63 | + # How many undos to hold? |
| 64 | + prefs["max_history_items"] = 32 |
| 65 | + |
| 66 | + # Shows whether to save history across sessions. |
| 67 | + prefs["save_history"] = True |
| 68 | + prefs["compress_history"] = False |
| 69 | + |
| 70 | + # Set the number spaces used for indenting. According to |
| 71 | + # :PEP:`8`, it is best to use 4 spaces. Since most of rope's |
| 72 | + # unit-tests use 4 spaces it is more reliable, too. |
| 73 | + prefs["indent_size"] = 4 |
| 74 | + |
| 75 | + # Builtin and c-extension modules that are allowed to be imported |
| 76 | + # and inspected by rope. |
| 77 | + prefs["extension_modules"] = [] |
| 78 | + |
| 79 | + # Add all standard c-extensions to extension_modules list. |
| 80 | + prefs["import_dynload_stdmods"] = True |
| 81 | + |
| 82 | + # If `True` modules with syntax errors are considered to be empty. |
| 83 | + # The default value is `False`; When `False` syntax errors raise |
| 84 | + # `rope.base.exceptions.ModuleSyntaxError` exception. |
| 85 | + prefs["ignore_syntax_errors"] = False |
| 86 | + |
| 87 | + # If `True`, rope ignores unresolvable imports. Otherwise, they |
| 88 | + # appear in the importing namespace. |
| 89 | + prefs["ignore_bad_imports"] = False |
| 90 | + |
| 91 | + # If `True`, rope will insert new module imports as |
| 92 | + # `from <package> import <module>` by default. |
| 93 | + prefs["prefer_module_from_imports"] = False |
| 94 | + |
| 95 | + # If `True`, rope will transform a comma list of imports into |
| 96 | + # multiple separate import statements when organizing |
| 97 | + # imports. |
| 98 | + prefs["split_imports"] = False |
| 99 | + |
| 100 | + # If `True`, rope will remove all top-level import statements and |
| 101 | + # reinsert them at the top of the module when making changes. |
| 102 | + prefs["pull_imports_to_top"] = True |
| 103 | + |
| 104 | + # If `True`, rope will sort imports alphabetically by module name instead |
| 105 | + # of alphabetically by import statement, with from imports after normal |
| 106 | + # imports. |
| 107 | + prefs["sort_imports_alphabetically"] = False |
| 108 | + |
| 109 | + # Location of implementation of |
| 110 | + # rope.base.oi.type_hinting.interfaces.ITypeHintingFactory In general |
| 111 | + # case, you don't have to change this value, unless you're an rope expert. |
| 112 | + # Change this value to inject you own implementations of interfaces |
| 113 | + # listed in module rope.base.oi.type_hinting.providers.interfaces |
| 114 | + # For example, you can add you own providers for Django Models, or disable |
| 115 | + # the search type-hinting in a class hierarchy, etc. |
| 116 | + prefs[ |
| 117 | + "type_hinting_factory" |
| 118 | + ] = "rope.base.oi.type_hinting.factory.default_type_hinting_factory" |
| 119 | + |
| 120 | + |
| 121 | +def project_opened(project): |
| 122 | + """This function is called after opening the project""" |
| 123 | + # Do whatever you like here! |
0 commit comments