├── requirements.txt ├── tests ├── issue23.py ├── lessthan39.py ├── issue35.py ├── issue29.py └── base_model.py ├── .style.yapf ├── .github ├── issue_template.md └── workflows │ ├── publish.yml │ └── test.yaml ├── setup.py ├── pylint_pydantic ├── field.py └── __init__.py ├── README.rst ├── .gitignore ├── pylintrc └── LICENSE /requirements.txt: -------------------------------------------------------------------------------- 1 | pylint>2.0,<5.0 2 | pydantic<3.0 3 | pylint_plugin_utils 4 | -------------------------------------------------------------------------------- /tests/issue23.py: -------------------------------------------------------------------------------- 1 | @lambda f: f 2 | def test_lambda_decorator(): 3 | pass 4 | -------------------------------------------------------------------------------- /tests/lessthan39.py: -------------------------------------------------------------------------------- 1 | from typing import Any, Dict, List 2 | 3 | from pydantic import BaseModel, Json 4 | 5 | # issue #11 6 | ExampleType2 = Json[Dict[str, str]] 7 | ExampleType3 = Json 8 | type_a: Json[List[str]] = [1, 2, 3, 4, 5] 9 | 10 | 11 | class AnyJsonModel(BaseModel): 12 | json_obj: Json[Any] 13 | json_obj2: Json[List[int]] 14 | -------------------------------------------------------------------------------- /tests/issue35.py: -------------------------------------------------------------------------------- 1 | from pydantic.v1 import BaseModel, Field 2 | 3 | 4 | class MyModel(BaseModel): 5 | items: list[int] = Field(...) 6 | value: str = Field(...) 7 | 8 | @property 9 | def get(self) -> str: 10 | return self.value[0:2] 11 | 12 | 13 | model = MyModel(items=[1, 2, 3, 4, 5], value="test") 14 | items = [i * i for i in model.items] 15 | print(items) 16 | -------------------------------------------------------------------------------- /.style.yapf: -------------------------------------------------------------------------------- 1 | [style] 2 | BASED_ON_STYLE = pep8 3 | COLUMN_LIMIT = 120 4 | SPACES_BEFORE_COMMENT = 2 5 | SPLIT_COMPLEX_COMPREHENSION = true 6 | DEDENT_CLOSING_BRACKETS = true 7 | COALESCE_BRACKETS = true 8 | ALIGN_CLOSING_BRACKET_WITH_VISUAL_INDENT = true 9 | BLANK_LINE_BEFORE_MODULE_DOCSTRING = true 10 | ARITHMETIC_PRECEDENCE_INDICATION = true 11 | SPLIT_ALL_TOP_LEVEL_COMMA_SEPARATED_VALUES = true 12 | SPLIT_ALL_COMMA_SEPARATED_VALUES = false 13 | INDENT_DICTIONARY_VALUE = true -------------------------------------------------------------------------------- /.github/issue_template.md: -------------------------------------------------------------------------------- 1 | ## Problem description 2 | 3 | xxxxxx 4 | 5 | ## Steps to reproduce the problem 6 | 7 | ```python 8 | example code 9 | ``` 10 | 11 | 12 | ## Specifications like the version of the project, operating system, or hardware 13 | ```python 14 | from pylint_pydantic import list_dependencies 15 | print(list_dependencies()) 16 | { 17 | "pylint": "3.0.3", 18 | "pylint_plugin_utils": "0.8.2", 19 | "astroid": "3.0.2", 20 | "pydantic": "2.5.2", 21 | "pylint_pydantic": "0.3.2", 22 | "python": "3.10.6 xxx" 23 | } 24 | ``` 25 | 26 | -------------------------------------------------------------------------------- /tests/issue29.py: -------------------------------------------------------------------------------- 1 | import pydantic 2 | from pydantic import model_validator, validator 3 | 4 | 5 | class A(pydantic.BaseModel): 6 | a: int = 10 7 | 8 | @pydantic.validator('a') 9 | def valid_pydantic_qualname(cls, values): 10 | return values 11 | 12 | @validator('a') 13 | def valid_pydantic_x(cls, values): 14 | return values 15 | 16 | @pydantic.model_validator(mode='before') 17 | def check_card_number_omitted1(cls, data): 18 | return data 19 | 20 | @model_validator(mode='before') 21 | def check_card_number_omitted2(cls, data): 22 | return data 23 | 24 | # pylint: disable=no-member 25 | @a.validator 26 | def _validate(self, _, value): 27 | assert value >= 0 28 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Upload Python Package 2 | 3 | on: 4 | release: 5 | types: [published] 6 | 7 | permissions: 8 | contents: read 9 | 10 | jobs: 11 | deploy: 12 | 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v3 17 | - name: Set up Python 18 | uses: actions/setup-python@v3 19 | with: 20 | python-version: '3.9' 21 | 22 | - name: Install Dependencies 23 | run: python -m pip install -r requirements.txt 24 | 25 | - name: Install Dependencies 26 | run: python -m pip install setuptools wheel 27 | 28 | - name: Build Package 29 | run: python setup.py bdist_wheel 30 | 31 | - name: Publish Package 32 | uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 33 | with: 34 | user: __token__ 35 | password: ${{ secrets.PYPI_API_TOKEN }} -------------------------------------------------------------------------------- /.github/workflows/test.yaml: -------------------------------------------------------------------------------- 1 | name: Python Test 2 | 3 | on: 4 | push: 5 | branches: [main] 6 | pull_request: 7 | types: [opened, synchronize] 8 | 9 | jobs: 10 | tests: 11 | runs-on: ubuntu-latest 12 | strategy: 13 | fail-fast: false 14 | matrix: 15 | python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"] 16 | 17 | steps: 18 | - uses: actions/checkout@v3 19 | - name: Set up Python ${{ matrix.python-version }} 20 | uses: actions/setup-python@v3 21 | with: 22 | python-version: ${{ matrix.python-version }} 23 | 24 | - name: Install Dependencies 25 | run: | 26 | python -m pip install -r requirements.txt 27 | python -m pip install setuptools 28 | 29 | - name: Install Self 30 | run: python setup.py develop 31 | 32 | - name: Test with pytest 33 | run: pylint --rcfile=pylintrc --load-plugins pylint_pydantic tests/ 34 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | LONG_DESCRIPTION = open("README.rst").read() 4 | with open("./requirements.txt", "r") as f: 5 | install_requires = f.read().splitlines() 6 | 7 | setup( 8 | name="pylint-pydantic", 9 | version="0.4.1", 10 | description="A Pylint plugin to help Pylint understand the Pydantic", 11 | long_description=LONG_DESCRIPTION, 12 | author="fcfangcc", 13 | author_email="swjfc22@163.com", 14 | url="https://github.com/fcfangcc/pylint-pydantic", 15 | packages=["pylint_pydantic"], 16 | license="GPLv3", 17 | classifiers=[ 18 | "Environment :: Console", 19 | "Intended Audience :: Developers", 20 | "Topic :: Software Development :: Quality Assurance", 21 | "Programming Language :: Python :: 3.10", 22 | "Programming Language :: Python :: 3.11", 23 | "Programming Language :: Python :: 3.12", 24 | "Programming Language :: Python :: 3.13", 25 | "Programming Language :: Python :: 3.14", 26 | ], 27 | keywords=["pylint", "pydantic"], 28 | python_requires=">=3.10", 29 | install_requires=install_requires, 30 | ) 31 | -------------------------------------------------------------------------------- /pylint_pydantic/field.py: -------------------------------------------------------------------------------- 1 | """ 2 | Implementation reference astroid/brain/brain_dataclasses.py 3 | """ 4 | from astroid import MANAGER, nodes 5 | from astroid.brain.brain_dataclasses import infer_dataclass_field_call 6 | from astroid.exceptions import InferenceError 7 | from astroid.inference_tip import inference_tip 8 | 9 | PYDANTIC_FIELD_MODULE = {"pydantic.fields", "pydantic.v1.fields"} 10 | PYDANTIC_FIELD_NAME = {"Field"} 11 | 12 | 13 | def _looks_like_pydantic_field_call(node: nodes.Call, check_scope: bool = True): 14 | if check_scope: 15 | stmt = node.statement() 16 | scope = stmt.scope() 17 | if not ( 18 | isinstance(stmt, nodes.AnnAssign) 19 | and stmt.value is not None 20 | and isinstance(scope, nodes.ClassDef) 21 | ): 22 | return False 23 | 24 | try: 25 | inferred = next(node.func.infer()) 26 | except (InferenceError, StopIteration): 27 | return False 28 | 29 | if not isinstance(inferred, nodes.FunctionDef): 30 | return False 31 | 32 | return ( 33 | inferred.name in PYDANTIC_FIELD_NAME 34 | and inferred.root().name in PYDANTIC_FIELD_MODULE 35 | ) 36 | 37 | 38 | MANAGER.register_transform( 39 | nodes.Call, 40 | inference_tip(infer_dataclass_field_call, raise_on_overwrite=True), 41 | _looks_like_pydantic_field_call, 42 | ) 43 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | pylint-pydantic 2 | ================ 3 | A Pylint plugin to help Pylint understand the Pydantic 4 | 5 | How to use 6 | =============== 7 | Installation 8 | 9 | .. code:: shell 10 | 11 | pip install pylint-pydantic 12 | 13 | Use in console 14 | 15 | .. code:: shell 16 | 17 | pylint --load-plugins pylint_pydantic xxxxx 18 | 19 | Use in vscode,settings.json add item 20 | 21 | .. code:: shell 22 | 23 | "pylint.args": ["--load-plugins", "pylint_pydantic"] 24 | # in old vscode version maybe 25 | "python.linting.pylintArgs": ["--load-plugins", "pylint_pydantic"] 26 | 27 | Tests 28 | ============ 29 | .. code:: shell 30 | 31 | pylint --rcfile=pylintrc --load-plugins pylint_pydantic tests/ 32 | ------------------------------------ 33 | Your code has been rated at 10.00/10 34 | 35 | FAQ 36 | ===================== 37 | - How to resolve `pylint: No name 'BaseModel' in module 'pydantic'`? 38 | Add `--extension-pkg-whitelist='pydantic'` parameter (see `#1961 `_) 39 | 40 | Other 41 | ===================== 42 | If you have any questions, please create a issue. 43 | https://github.com/fcfangcc/pylint-pydantic/issues 44 | 45 | 46 | Changelog 47 | ===================== 48 | 49 | - v0.4.0: Support pylint4,Remove support for python3.9 50 | - v0.3.4: fixed #35 #34 51 | - v0.3.1: fixed #29 52 | - v0.3.0: support pylint3 53 | - v0.2.4: fix pydantic.Field with BaseModel support 54 | - v0.2.2: fix model_validator keyword **mode**, pydatic>=2.0.3 55 | - v0.2.1: support `model_validator` 56 | - v0.2.0: support Pydantic V2 57 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | .vscode/ -------------------------------------------------------------------------------- /tests/base_model.py: -------------------------------------------------------------------------------- 1 | import dataclasses 2 | import datetime 3 | from typing import Any 4 | 5 | import pydantic 6 | from pydantic import BaseModel, Field, Json, constr, model_validator, root_validator, validator 7 | from pydantic.dataclasses import dataclass 8 | 9 | 10 | class A(BaseModel): 11 | a: int = 10 12 | b: constr(max_length=10) 13 | 14 | @property 15 | def test(self): 16 | return f"{self.a+10}" 17 | 18 | @validator("a") 19 | def valid_after(cls, value): 20 | return value 21 | 22 | @validator("a", pre=True) 23 | def valid_pre(cls, value): 24 | return value 25 | 26 | @root_validator 27 | def valid_root_after(cls, values): 28 | return values 29 | 30 | @root_validator(pre=True) 31 | def valid_root_pre(cls, values): 32 | return values 33 | 34 | @pydantic.root_validator 35 | def valid_pydantic_qualname(cls, values): 36 | return values 37 | 38 | @pydantic.root_validator(pre=True) 39 | def valid_pydantic_qualname_pre(cls, values): 40 | return values 41 | 42 | @root_validator 43 | def valid_static_method(cls, values): 44 | values[cls.__name__] = cls.__name__ 45 | return values 46 | 47 | @model_validator(mode='before') 48 | def pre_root(cls, values: dict[str, Any]) -> dict[str, Any]: 49 | return values 50 | 51 | 52 | class SampleModel(BaseModel): 53 | host: str = "0.0.0.0" 54 | port: int = 8080 55 | 56 | 57 | # issue #9 58 | class TooFewPublicMethods(BaseModel): 59 | value: str 60 | 61 | class Config: # this line raise too-few-public-methods 62 | max_anystr_length = 10 63 | 64 | 65 | class TooFewPublicMethodsNested(TooFewPublicMethods): 66 | 67 | class Config: 68 | max_anystr_length = 20 69 | 70 | 71 | # issue #11 #14 72 | ExampleType1 = pydantic.Json[dict[str, str]] 73 | ExampleType2 = Json[dict[str, str]] 74 | ExampleType3 = Json 75 | type_a: Json[list[str]] = [1, 2, 3, 4, 5] 76 | 77 | 78 | class AnyJsonModel(BaseModel): 79 | json_obj: Json[Any] 80 | json_obj2: Json[list[int]] 81 | json_obj3: Json[TooFewPublicMethods] 82 | 83 | 84 | def test_func(params: Json[list]): 85 | for i in params: 86 | print(i) 87 | 88 | 89 | # issue #22 90 | class UserModel(BaseModel): 91 | username: str 92 | password1: str 93 | password2: str 94 | 95 | @model_validator(mode='before') 96 | def check_card_number_omitted1(cls, data): 97 | return data 98 | 99 | @pydantic.model_validator(mode='before') 100 | def check_card_number_omitted2(cls, data): 101 | return data 102 | 103 | @model_validator(mode='after') 104 | def check_passwords_match1(self) -> 'UserModel': 105 | return self 106 | 107 | @pydantic.model_validator(mode='after') 108 | def check_passwords_match2(self) -> 'UserModel': 109 | return self 110 | 111 | 112 | # issue 24 113 | class MyModel(BaseModel): 114 | data: dict[float, float] = Field(default_factory=dict) 115 | 116 | def get_data(self, key: float) -> float: 117 | return self.data[key] 118 | 119 | 120 | @dataclass 121 | class UserTest: 122 | id: int 123 | name: str = 'John Doe' 124 | signup_ts: datetime = None 125 | friends: list[int] = dataclasses.field(default_factory=lambda: [0]) 126 | data: dict[float, float] = Field(default_factory=dict) 127 | 128 | def testa(self): 129 | return self.data[1.0], self.friends[0], self.signup_ts.date() 130 | -------------------------------------------------------------------------------- /pylint_pydantic/__init__.py: -------------------------------------------------------------------------------- 1 | import astroid 2 | from astroid import MANAGER, Attribute, Call, ClassDef, FunctionDef, InferenceError, Name, nodes 3 | from pylint.checkers.design_analysis import MisdesignChecker 4 | from pylint_plugin_utils import suppress_message 5 | 6 | from . import field 7 | 8 | CLASSMETHOD_VALIDATOR_NAMES = {"validator", "root_validator", "field_validator"} 9 | MODE_VALIDATOR_NAMES = {"model_validator"} 10 | MODULE_NAME = "pydantic" 11 | 12 | 13 | def _mode_validator_is_classmethod(call: Call): 14 | # https://docs.pydantic.dev/latest/api/functional_validators/#pydantic.functional_validators.model_validator 15 | for keyword in call.keywords: 16 | if keyword.arg == "mode" and "after" in keyword.value.as_string(): 17 | return False 18 | return True 19 | 20 | 21 | # def _get_decorator_name(decorator: Name | Attribute): 22 | def _get_decorator_name(decorator): 23 | # @validator(pre=True) 24 | if isinstance(decorator, Call): 25 | decorator = decorator.func 26 | 27 | # @validator 28 | if isinstance(decorator, Name): 29 | return decorator.name 30 | 31 | # @pydantic.validator 32 | if isinstance(decorator, Attribute): 33 | return decorator.attrname 34 | 35 | return None 36 | 37 | 38 | def _infer_is_pydantic_decorator(node): 39 | # @validator(pre=True) 40 | if isinstance(node, Call): 41 | node = node.func 42 | 43 | try: 44 | inferreds = node.inferred() 45 | inferred = inferreds[0] if inferreds else None 46 | if inferred: 47 | name = inferred.root().name 48 | return name.startswith(MODULE_NAME) 49 | except (InferenceError, StopIteration): 50 | return False 51 | 52 | return False 53 | 54 | 55 | def _is_classmethod_decorator(node: FunctionDef): 56 | if not node.decorators: 57 | return False 58 | 59 | for decorator in node.decorators.get_children(): 60 | if _infer_is_pydantic_decorator(decorator): 61 | decorator_name = _get_decorator_name(decorator) 62 | 63 | if decorator_name is None: 64 | return False 65 | 66 | if decorator_name in CLASSMETHOD_VALIDATOR_NAMES: 67 | return True 68 | 69 | if decorator_name in MODE_VALIDATOR_NAMES: 70 | return _mode_validator_is_classmethod(decorator) 71 | 72 | return False 73 | 74 | 75 | def transform(node: FunctionDef): 76 | if _is_classmethod_decorator(node): 77 | node.type = "classmethod" 78 | return node 79 | 80 | 81 | def is_pydantic_config_class(node: ClassDef): 82 | if node.name == "Config" \ 83 | and isinstance(node.parent, ClassDef) \ 84 | and node.parent.is_subtype_of("pydantic.main.BaseModel"): 85 | return True 86 | return False 87 | 88 | 89 | def transform_pydantic_json(node: nodes.Subscript): 90 | if "Json" in node.value.as_string(): 91 | for inference in node.value.inferred(): 92 | if isinstance(inference, ClassDef) and inference.is_subtype_of("pydantic.types.Json"): 93 | new_subscript = astroid.extract_node(node.slice.as_string()) 94 | return new_subscript 95 | return None 96 | 97 | 98 | def register(linter): 99 | MANAGER.register_transform(FunctionDef, transform) 100 | MANAGER.register_transform(nodes.Subscript, transform_pydantic_json) 101 | suppress_message(linter, MisdesignChecker.leave_classdef, 'too-few-public-methods', is_pydantic_config_class) 102 | 103 | 104 | # pylint: disable=import-outside-toplevel 105 | def list_dependencies(): 106 | import json 107 | import sys 108 | from importlib.metadata import version 109 | dependencies = ["pylint", "pylint_plugin_utils", "astroid", "pydantic", "pylint_pydantic"] 110 | info = {i: version(i) for i in dependencies} 111 | info["python"] = sys.version 112 | return json.dumps(info, indent=4) 113 | -------------------------------------------------------------------------------- /pylintrc: -------------------------------------------------------------------------------- 1 | [MASTER] 2 | 3 | # A comma-separated list of package or module names from where C extensions may 4 | # be loaded. Extensions are loading into the active Python interpreter and may 5 | # run arbitrary code. 6 | extension-pkg-whitelist=pydantic 7 | 8 | # Add files or directories to the blacklist. They should be base names, not 9 | # paths. 10 | ignore=CVS 11 | 12 | # Add files or directories matching the regex patterns to the blacklist. The 13 | # regex matches against base names, not paths. 14 | ignore-patterns= 15 | 16 | # Python code to execute, usually for sys.path manipulation such as 17 | # pygtk.require(). 18 | #init-hook= 19 | 20 | # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the 21 | # number of processors available to use. 22 | jobs=1 23 | 24 | # Control the amount of potential inferred values when inferring a single 25 | # object. This can help the performance when dealing with large functions or 26 | # complex, nested conditions. 27 | limit-inference-results=100 28 | 29 | # List of plugins (as comma separated values of python module names) to load, 30 | # usually to register additional checkers. 31 | load-plugins= 32 | 33 | # Pickle collected data for later comparisons. 34 | persistent=yes 35 | 36 | # Specify a configuration file. 37 | #rcfile= 38 | 39 | # When enabled, pylint would attempt to guess common misconfiguration and emit 40 | # user-friendly hints instead of false-positive error messages. 41 | suggestion-mode=yes 42 | 43 | # Allow loading of arbitrary C extensions. Extensions are imported into the 44 | # active Python interpreter and may run arbitrary code. 45 | unsafe-load-any-extension=no 46 | 47 | 48 | [MESSAGES CONTROL] 49 | 50 | # Only show warnings with the listed confidence levels. Leave empty to show 51 | # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. 52 | confidence= 53 | 54 | # Disable the message, report, category or checker with the given id(s). You 55 | # can either give multiple identifiers separated by comma (,) or put this 56 | # option multiple times (only on the command line, not in the configuration 57 | # file where it should appear only once). You can also use "--disable=all" to 58 | # disable everything first and then reenable specific checks. For example, if 59 | # you want to run only the similarities checker, you can use "--disable=all 60 | # --enable=similarities". If you want to run only the classes checker, but have 61 | # no Warning level messages displayed, use "--disable=all --enable=classes 62 | # --disable=W". 63 | disable=missing-function-docstring, 64 | missing-module-docstring, 65 | missing-class-docstring, 66 | invalid-name, 67 | too-few-public-methods 68 | 69 | 70 | # Enable the message, report, category or checker with the given id(s). You can 71 | # either give multiple identifier separated by comma (,) or put this option 72 | # multiple time (only on the command line, not in the configuration file where 73 | # it should appear only once). See also the "--disable" option for examples. 74 | enable=c-extension-no-member 75 | 76 | 77 | [REPORTS] 78 | 79 | # Python expression which should return a score less than or equal to 10. You 80 | # have access to the variables 'error', 'warning', 'refactor', and 'convention' 81 | # which contain the number of messages in each category, as well as 'statement' 82 | # which is the total number of statements analyzed. This score is used by the 83 | # global evaluation report (RP0004). 84 | evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) 85 | 86 | # Template used to display messages. This is a python new-style format string 87 | # used to format the message information. See doc for all details. 88 | #msg-template= 89 | 90 | # Set the output format. Available formats are text, parseable, colorized, json 91 | # and msvs (visual studio). You can also give a reporter class, e.g. 92 | # mypackage.mymodule.MyReporterClass. 93 | output-format=text 94 | 95 | # Tells whether to display a full report or only the messages. 96 | reports=no 97 | 98 | # Activate the evaluation score. 99 | score=yes 100 | 101 | 102 | [REFACTORING] 103 | 104 | # Maximum number of nested blocks for function / method body 105 | max-nested-blocks=5 106 | 107 | # Complete name of functions that never returns. When checking for 108 | # inconsistent-return-statements if a never returning function is called then 109 | # it will be considered as an explicit return statement and no message will be 110 | # printed. 111 | never-returning-functions=sys.exit 112 | 113 | 114 | [BASIC] 115 | 116 | # Naming style matching correct argument names. 117 | argument-naming-style=snake_case 118 | 119 | # Regular expression matching correct argument names. Overrides argument- 120 | # naming-style. 121 | #argument-rgx= 122 | 123 | # Naming style matching correct attribute names. 124 | attr-naming-style=snake_case 125 | 126 | # Regular expression matching correct attribute names. Overrides attr-naming- 127 | # style. 128 | #attr-rgx= 129 | 130 | # Bad variable names which should always be refused, separated by a comma. 131 | bad-names=foo, 132 | bar, 133 | baz, 134 | toto, 135 | tutu, 136 | tata 137 | 138 | # Naming style matching correct class attribute names. 139 | class-attribute-naming-style=any 140 | 141 | # Regular expression matching correct class attribute names. Overrides class- 142 | # attribute-naming-style. 143 | #class-attribute-rgx= 144 | 145 | # Naming style matching correct class names. 146 | class-naming-style=PascalCase 147 | 148 | # Regular expression matching correct class names. Overrides class-naming- 149 | # style. 150 | #class-rgx= 151 | 152 | # Naming style matching correct constant names. 153 | const-naming-style=UPPER_CASE 154 | 155 | # Regular expression matching correct constant names. Overrides const-naming- 156 | # style. 157 | #const-rgx= 158 | 159 | # Minimum line length for functions/classes that require docstrings, shorter 160 | # ones are exempt. 161 | docstring-min-length=-1 162 | 163 | # Naming style matching correct function names. 164 | function-naming-style=snake_case 165 | 166 | # Regular expression matching correct function names. Overrides function- 167 | # naming-style. 168 | #function-rgx= 169 | 170 | # Good variable names which should always be accepted, separated by a comma. 171 | good-names=i, 172 | j, 173 | k, 174 | ex, 175 | Run, 176 | _ 177 | 178 | # Include a hint for the correct naming format with invalid-name. 179 | include-naming-hint=no 180 | 181 | # Naming style matching correct inline iteration names. 182 | inlinevar-naming-style=any 183 | 184 | # Regular expression matching correct inline iteration names. Overrides 185 | # inlinevar-naming-style. 186 | #inlinevar-rgx= 187 | 188 | # Naming style matching correct method names. 189 | method-naming-style=snake_case 190 | 191 | # Regular expression matching correct method names. Overrides method-naming- 192 | # style. 193 | #method-rgx= 194 | 195 | # Naming style matching correct module names. 196 | module-naming-style=snake_case 197 | 198 | # Regular expression matching correct module names. Overrides module-naming- 199 | # style. 200 | #module-rgx= 201 | 202 | # Colon-delimited sets of names that determine each other's naming style when 203 | # the name regexes allow several styles. 204 | name-group= 205 | 206 | # Regular expression which should only match function or class names that do 207 | # not require a docstring. 208 | no-docstring-rgx=^_ 209 | 210 | # List of decorators that produce properties, such as abc.abstractproperty. Add 211 | # to this list to register other decorators that produce valid properties. 212 | # These decorators are taken in consideration only for invalid-name. 213 | property-classes=abc.abstractproperty 214 | 215 | # Naming style matching correct variable names. 216 | variable-naming-style=snake_case 217 | 218 | # Regular expression matching correct variable names. Overrides variable- 219 | # naming-style. 220 | #variable-rgx= 221 | 222 | 223 | [FORMAT] 224 | 225 | # Expected format of line ending, e.g. empty (any line ending), LF or CRLF. 226 | expected-line-ending-format= 227 | 228 | # Regexp for a line that is allowed to be longer than the limit. 229 | ignore-long-lines=^\s*(# )??$ 230 | 231 | # Number of spaces of indent required inside a hanging or continued line. 232 | indent-after-paren=4 233 | 234 | # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 235 | # tab). 236 | indent-string=' ' 237 | 238 | # Maximum number of characters on a single line. 239 | max-line-length=120 240 | 241 | # Maximum number of lines in a module. 242 | max-module-lines=1000 243 | 244 | # Allow the body of a class to be on the same line as the declaration if body 245 | # contains single statement. 246 | single-line-class-stmt=no 247 | 248 | # Allow the body of an if to be on the same line as the test if there is no 249 | # else. 250 | single-line-if-stmt=no 251 | 252 | 253 | [LOGGING] 254 | 255 | # Format style used to check logging format string. `old` means using % 256 | # formatting, `new` is for `{}` formatting,and `fstr` is for f-strings. 257 | logging-format-style=old 258 | 259 | # Logging modules to check that the string format arguments are in logging 260 | # function parameter format. 261 | logging-modules=logging 262 | 263 | 264 | [MISCELLANEOUS] 265 | 266 | # List of note tags to take in consideration, separated by a comma. 267 | notes=FIXME, 268 | XXX, 269 | TODO 270 | 271 | 272 | [SIMILARITIES] 273 | 274 | # Ignore comments when computing similarities. 275 | ignore-comments=yes 276 | 277 | # Ignore docstrings when computing similarities. 278 | ignore-docstrings=yes 279 | 280 | # Ignore imports when computing similarities. 281 | ignore-imports=no 282 | 283 | # Minimum lines number of a similarity. 284 | min-similarity-lines=8 285 | 286 | 287 | [SPELLING] 288 | 289 | # Limits count of emitted suggestions for spelling mistakes. 290 | max-spelling-suggestions=4 291 | 292 | # Spelling dictionary name. Available dictionaries: none. To make it work, 293 | # install the python-enchant package. 294 | spelling-dict= 295 | 296 | # List of comma separated words that should not be checked. 297 | spelling-ignore-words= 298 | 299 | # A path to a file that contains the private dictionary; one word per line. 300 | spelling-private-dict-file= 301 | 302 | # Tells whether to store unknown words to the private dictionary (see the 303 | # --spelling-private-dict-file option) instead of raising a message. 304 | spelling-store-unknown-words=no 305 | 306 | 307 | [STRING] 308 | 309 | # This flag controls whether the implicit-str-concat-in-sequence should 310 | # generate a warning on implicit string concatenation in sequences defined over 311 | # several lines. 312 | check-str-concat-over-line-jumps=no 313 | 314 | 315 | [TYPECHECK] 316 | 317 | # List of decorators that produce context managers, such as 318 | # contextlib.contextmanager. Add to this list to register other decorators that 319 | # produce valid context managers. 320 | contextmanager-decorators=contextlib.contextmanager 321 | 322 | # List of members which are set dynamically and missed by pylint inference 323 | # system, and so shouldn't trigger E1101 when accessed. Python regular 324 | # expressions are accepted. 325 | generated-members= 326 | 327 | # Tells whether missing members accessed in mixin class should be ignored. A 328 | # mixin class is detected if its name ends with "mixin" (case insensitive). 329 | ignore-mixin-members=yes 330 | 331 | # Tells whether to warn about missing members when the owner of the attribute 332 | # is inferred to be None. 333 | ignore-none=yes 334 | 335 | # This flag controls whether pylint should warn about no-member and similar 336 | # checks whenever an opaque object is returned when inferring. The inference 337 | # can return multiple potential results while evaluating a Python object, but 338 | # some branches might not be evaluated, which results in partial inference. In 339 | # that case, it might be useful to still emit no-member and other checks for 340 | # the rest of the inferred objects. 341 | ignore-on-opaque-inference=yes 342 | 343 | # List of class names for which member attributes should not be checked (useful 344 | # for classes with dynamically set attributes). This supports the use of 345 | # qualified names. 346 | ignored-classes=optparse.Values,thread._local,_thread._local 347 | 348 | # List of module names for which member attributes should not be checked 349 | # (useful for modules/projects where namespaces are manipulated during runtime 350 | # and thus existing member attributes cannot be deduced by static analysis). It 351 | # supports qualified module names, as well as Unix pattern matching. 352 | ignored-modules= 353 | 354 | # Show a hint with possible names when a member name was not found. The aspect 355 | # of finding the hint is based on edit distance. 356 | missing-member-hint=yes 357 | 358 | # The minimum edit distance a name should have in order to be considered a 359 | # similar match for a missing member name. 360 | missing-member-hint-distance=1 361 | 362 | # The total number of similar names that should be taken in consideration when 363 | # showing a hint for a missing member. 364 | missing-member-max-choices=1 365 | 366 | # List of decorators that change the signature of a decorated function. 367 | signature-mutators= 368 | 369 | 370 | [VARIABLES] 371 | 372 | # List of additional names supposed to be defined in builtins. Remember that 373 | # you should avoid defining new builtins when possible. 374 | additional-builtins= 375 | 376 | # Tells whether unused global variables should be treated as a violation. 377 | allow-global-unused-variables=yes 378 | 379 | # List of strings which can identify a callback function by name. A callback 380 | # name must start or end with one of those strings. 381 | callbacks=cb_, 382 | _cb 383 | 384 | # A regular expression matching the name of dummy variables (i.e. expected to 385 | # not be used). 386 | dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ 387 | 388 | # Argument names that match this expression will be ignored. Default to name 389 | # with leading underscore. 390 | ignored-argument-names=_.*|^ignored_|^unused_ 391 | 392 | # Tells whether we should check for unused import in __init__ files. 393 | init-import=no 394 | 395 | # List of qualified module names which can have objects that can redefine 396 | # builtins. 397 | redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io 398 | 399 | 400 | [CLASSES] 401 | 402 | # List of method names used to declare (i.e. assign) instance attributes. 403 | defining-attr-methods=__init__, 404 | __new__, 405 | setUp, 406 | __post_init__ 407 | 408 | # List of member names, which should be excluded from the protected access 409 | # warning. 410 | exclude-protected=_asdict, 411 | _fields, 412 | _replace, 413 | _source, 414 | _make 415 | 416 | # List of valid names for the first argument in a class method. 417 | valid-classmethod-first-arg=cls 418 | 419 | # List of valid names for the first argument in a metaclass class method. 420 | valid-metaclass-classmethod-first-arg=cls 421 | 422 | 423 | [DESIGN] 424 | 425 | # Maximum number of arguments for function / method. 426 | max-args=5 427 | 428 | # Maximum number of attributes for a class (see R0902). 429 | max-attributes=7 430 | 431 | # Maximum number of boolean expressions in an if statement (see R0916). 432 | max-bool-expr=5 433 | 434 | # Maximum number of branch for function / method body. 435 | max-branches=12 436 | 437 | # Maximum number of locals for function / method body. 438 | max-locals=15 439 | 440 | # Maximum number of parents for a class (see R0901). 441 | max-parents=7 442 | 443 | # Maximum number of public methods for a class (see R0904). 444 | max-public-methods=20 445 | 446 | # Maximum number of return / yield for function / method body. 447 | max-returns=6 448 | 449 | # Maximum number of statements in function / method body. 450 | max-statements=50 451 | 452 | # Minimum number of public methods for a class (see R0903). 453 | min-public-methods=2 454 | 455 | 456 | [IMPORTS] 457 | 458 | # List of modules that can be imported at any level, not just the top level 459 | # one. 460 | allow-any-import-level= 461 | 462 | # Allow wildcard imports from modules that define __all__. 463 | allow-wildcard-with-all=no 464 | 465 | # Analyse import fallback blocks. This can be used to support both Python 2 and 466 | # 3 compatible code, which means that the block might have code that exists 467 | # only in one or another interpreter, leading to false positives when analysed. 468 | analyse-fallback-blocks=no 469 | 470 | # Deprecated modules which should not be used, separated by a comma. 471 | deprecated-modules=optparse,tkinter.tix 472 | 473 | # Create a graph of external dependencies in the given file (report RP0402 must 474 | # not be disabled). 475 | ext-import-graph= 476 | 477 | # Create a graph of every (i.e. internal and external) dependencies in the 478 | # given file (report RP0402 must not be disabled). 479 | import-graph= 480 | 481 | # Create a graph of internal dependencies in the given file (report RP0402 must 482 | # not be disabled). 483 | int-import-graph= 484 | 485 | # Force import order to recognize a module as part of the standard 486 | # compatibility libraries. 487 | known-standard-library= 488 | 489 | # Force import order to recognize a module as part of a third party library. 490 | known-third-party=enchant 491 | 492 | # Couples of modules and preferred modules, separated by a comma. 493 | preferred-modules= 494 | 495 | 496 | [EXCEPTIONS] 497 | 498 | # Exceptions that will emit a warning when being caught. Defaults to 499 | # "BaseException, Exception". 500 | overgeneral-exceptions=builtins.BaseException, 501 | builtins.Exception 502 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------