Merge pull request #351 from online-judge-tools/update/pylint

Enable pylint

Author: kmyk

.github/workflows/format.yml

@@ -7,10 +7,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v2
 
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.8'
 
     - name: Install dependencies
       run: pip3 install .[dev]
@@ -19,7 +21,7 @@ jobs:
       run: oj-verify -h
 
     - name: Run pylint
-      run: pylint --disable=all --enable=unused-import onlinejudge_verify onlinejudge_bundle tests setup.py
+      run: pylint --rcfile=setup.cfg onlinejudge_verify onlinejudge_bundle tests setup.py
 
     - name: Run isort
       run: isort --check-only --diff onlinejudge_verify onlinejudge_bundle tests setup.py

CONTRIBUTING.md

@@ -30,7 +30,7 @@ You can run the format checking with the following commands. You can automatical
 set -e
 
 mypy onlinejudge_verify onlinejudge_bundle tests setup.py
-pylint --disable=all --enable=unused-import onlinejudge_verify onlinejudge_bundle tests setup.py
+pylint --rcfile=setup.cfg onlinejudge_verify onlinejudge_bundle tests setup.py
 isort --check-only --diff onlinejudge_verify onlinejudge_bundle tests setup.py
 yapf --diff --recursive onlinejudge_verify onlinejudge_bundle tests setup.py
 ```

onlinejudge_verify/config.py

@@ -13,7 +13,7 @@
 
 
 def set_config_path(config_path: pathlib.Path) -> None:
-    global _loaded_config
+    global _loaded_config  # pylint: disable=invalid-name
     assert _loaded_config is None
     if not config_path.exists():
         _loaded_config = {}

onlinejudge_verify/documentation/build.py

@@ -17,8 +17,8 @@
 
 logger = getLogger(__name__)
 
-_resource_package = 'onlinejudge_verify_resources'
-_copied_static_file_paths: List[str] = [
+_RESOURCE_PACKAGE = 'onlinejudge_verify_resources'
+_COPIED_STATIC_FILE_PATHS: List[str] = [
     '_layouts/page.html',
     '_layouts/document.html',
     '_layouts/toppage.html',
@@ -107,9 +107,9 @@ def ext(relative_path: pathlib.Path) -> Dict[str, Any]:
             'icon': _get_verification_status_icon(stat.verification_status),
         }
 
-    data['_extendedDependsOn'] = [ext(path) for path in sorted(stat.depends_on, key=lambda x: str(x))]
-    data['_extendedRequiredBy'] = [ext(path) for path in sorted(stat.required_by, key=lambda x: str(x))]
-    data['_extendedVerifiedWith'] = [ext(path) for path in sorted(stat.verified_with, key=lambda x: str(x))]
+    data['_extendedDependsOn'] = [ext(path) for path in sorted(stat.depends_on, key=str)]
+    data['_extendedRequiredBy'] = [ext(path) for path in sorted(stat.required_by, key=str)]
+    data['_extendedVerifiedWith'] = [ext(path) for path in sorted(stat.verified_with, key=str)]
 
     return data
 
@@ -120,13 +120,13 @@ def _render_source_code_stats_for_top_page(
     page_title_dict: Dict[pathlib.Path, str],
     basedir: pathlib.Path,
 ) -> Dict[str, Any]:
-    libraryCategories: Dict[str, List[Dict[str, str]]] = {}
-    verificationCategories: Dict[str, List[Dict[str, str]]] = {}
+    library_categories: Dict[str, List[Dict[str, str]]] = {}
+    verification_categories: Dict[str, List[Dict[str, str]]] = {}
     for stat in source_code_stats:
         if utils.is_verification_file(stat.path, basedir=basedir):
-            categories = verificationCategories
+            categories = verification_categories
         else:
-            categories = libraryCategories
+            categories = library_categories
         category = str(stat.path.parent)
         if category not in categories:
             categories[category] = []
@@ -138,13 +138,13 @@ def _render_source_code_stats_for_top_page(
 
     data: Dict[str, Any] = {}
     data['libraryCategories'] = []
-    for category, pages in libraryCategories.items():
+    for category, pages in library_categories.items():
         data['libraryCategories'].append({
             'name': category,
             'pages': pages,
         })
     data['verificationCategories'] = []
-    for category, pages in verificationCategories.items():
+    for category, pages in verification_categories.items():
         data['verificationCategories'].append({
             'name': category,
             'pages': pages,
@@ -195,8 +195,8 @@ def load_static_files(*, site_render_config: SiteRenderConfig) -> Dict[pathlib.P
     files[site_render_config.destination_dir / '_config.yml'] = yaml.safe_dump(site_render_config.config_yml).encode()
 
     # load files in onlinejudge_verify_resources/
-    for path in _copied_static_file_paths:
-        files[site_render_config.destination_dir / pathlib.Path(path)] = pkg_resources.resource_string(_resource_package, path)
+    for path in _COPIED_STATIC_FILE_PATHS:
+        files[site_render_config.destination_dir / pathlib.Path(path)] = pkg_resources.resource_string(_RESOURCE_PACKAGE, path)
 
     # overwrite with docs/static
     for src in site_render_config.static_dir.glob('**/*'):

onlinejudge_verify/documentation/main.py

@@ -13,8 +13,8 @@
 
 logger = getLogger(__name__)
 
-_resource_package = 'onlinejudge_verify_resources'
-_config_yml_path: str = '_config.yml'
+_RESOURCE_PACKAGE = 'onlinejudge_verify_resources'
+_CONFIG_YML_PATH: str = '_config.yml'
 
 
 def print_stats_json(*, jobs: int = 1) -> None:
@@ -31,7 +31,7 @@ def print_stats_json(*, jobs: int = 1) -> None:
 
 def load_render_config(*, basedir: pathlib.Path) -> SiteRenderConfig:
     # load default _config.yml
-    default_config_yml = yaml.safe_load(pkg_resources.resource_string(_resource_package, _config_yml_path))
+    default_config_yml = yaml.safe_load(pkg_resources.resource_string(_RESOURCE_PACKAGE, _CONFIG_YML_PATH))
     assert default_config_yml is not None
     config_yml = default_config_yml
 

onlinejudge_verify/languages/cplusplus_bundle.py

@@ -11,9 +11,9 @@
 
 logger = getLogger(__name__)
 
-bits_stdcxx_h = 'bits/stdc++.h'
+BITS_STDCXX_H = 'bits/stdc++.h'
 
-cxx_standard_libs = {
+CXX_STANDARD_LIBS = {
     'algorithm',
     'array',
     'bitset',
@@ -61,7 +61,7 @@
     'vector',
 }
 
-c_standard_libs = {
+C_STANDARD_LIBS = {
     'assert.h',
     'complex.h',
     'ctype.h',
@@ -93,11 +93,11 @@
     'wctype.h',
 }
 
-cxx_c_origin_libs = {'c' + name[:-len('.h')] for name in c_standard_libs}
+CXX_C_ORIGIN_LIBS = {'c' + name[:-len('.h')] for name in C_STANDARD_LIBS}
 
-bits_extcxx_h = 'bits/extc++.h'
+BITS_EXTCXX_H = 'bits/extc++.h'
 
-ext_libs = {
+EXT_LIBS = {
     'ext/algorithm',
     'ext/array_allocator.h',
     'ext/atomicity.h',
@@ -134,9 +134,9 @@
     'ext/pb_ds/trie_policy.hpp',
 }
 
-bits_stdtr1cxx_h = 'bits/stdtr1c++.h'
+BITS_STDTR1CXX_H = 'bits/stdtr1c++.h'
 
-tr1_libs = {
+TR1_LIBS = {
     'tr1/array',
     'tr1/cctype',
     'tr1/cfenv',
@@ -219,15 +219,17 @@ def __init__(self, path: pathlib.Path, line: int, message: str, *args, **kwargs)
         super().__init__(message, *args, **kwargs)  # type: ignore
 
 
-class Bundler(object):
+class Bundler:
     iquotes: List[pathlib.Path]
     pragma_once: Set[pathlib.Path]
     pragma_once_system: Set[str]
     result_lines: List[bytes]
     path_stack: Set[pathlib.Path]
     compiler: str
 
-    def __init__(self, *, iquotes: List[pathlib.Path] = [], compiler: str = os.environ.get('CXX', 'g++')) -> None:
+    def __init__(self, *, iquotes: Optional[List[pathlib.Path]] = None, compiler: str = os.environ.get('CXX', 'g++')) -> None:
+        if iquotes is None:
+            iquotes = []
         self.iquotes = iquotes
         self.pragma_once = set()
         self.pragma_once_system = set()
@@ -362,20 +364,20 @@ def update(self, path: pathlib.Path) -> None:
                     elif not is_toplevel:
                         # #pragma once 系の判断ができない場合はそっとしておく
                         self.result_lines.append(line)
-                    elif included in c_standard_libs or included in cxx_standard_libs or included in cxx_c_origin_libs:
-                        if bits_stdcxx_h in self.pragma_once_system:
+                    elif included in C_STANDARD_LIBS or included in CXX_STANDARD_LIBS or included in CXX_C_ORIGIN_LIBS:
+                        if BITS_STDCXX_H in self.pragma_once_system:
                             self._line(i + 2, path)
                         else:
                             self.pragma_once_system.add(included)
                             self.result_lines.append(line)
-                    elif included in ext_libs:
-                        if bits_extcxx_h in self.pragma_once_system:
+                    elif included in EXT_LIBS:
+                        if BITS_EXTCXX_H in self.pragma_once_system:
                             self._line(i + 2, path)
                         else:
                             self.pragma_once_system.add(included)
                             self.result_lines.append(line)
-                    elif included in tr1_libs:
-                        if bits_stdtr1cxx_h in self.pragma_once_system:
+                    elif included in TR1_LIBS:
+                        if BITS_STDTR1CXX_H in self.pragma_once_system:
                             self._line(i + 2, path)
                         else:
                             self.pragma_once_system.add(included)
@@ -384,8 +386,8 @@ def update(self, path: pathlib.Path) -> None:
                         # possibly: bits/*, tr2/* boost/*, c-posix library, etc.
                         self.pragma_once_system.add(included)
                         self.result_lines.append(line)
-                        if included in [bits_extcxx_h, bits_stdtr1cxx_h]:
-                            self.pragma_once_system.add(bits_stdcxx_h)
+                        if included in [BITS_EXTCXX_H, BITS_STDTR1CXX_H]:
+                            self.pragma_once_system.add(BITS_STDCXX_H)
                     continue
 
                 # #include "..."

onlinejudge_verify/languages/list.py

@@ -20,7 +20,7 @@
 
 
 def _get_dict() -> Dict[str, Language]:
-    global _dict
+    global _dict  # pylint: disable=invalid-name
     if _dict is None:
         _dict = {}
         _dict['.cpp'] = CPlusPlusLanguage()
@@ -42,7 +42,7 @@ def _get_dict() -> Dict[str, Language]:
                         if key in config:
                             raise RuntimeError("You cannot overwrite existing language: .{}".format(ext))
             else:
-                logger.warn("config.toml: languages.%s: Adding new languages using `config.toml` is supported but not recommended. Please consider making pull requests for your languages, see https://github.com/kmyk/online-judge-verify-helper/issues/116", ext)
+                logger.warning("config.toml: languages.%s: Adding new languages using `config.toml` is supported but not recommended. Please consider making pull requests for your languages, see https://github.com/kmyk/online-judge-verify-helper/issues/116", ext)
                 _dict['.' + ext] = UserDefinedLanguage(extension=ext, config=config)
     return _dict
 

onlinejudge_verify/languages/models.py

@@ -6,7 +6,7 @@
 import onlinejudge_verify.languages.special_comments as special_comments
 
 
-class LanguageEnvironment(object):
+class LanguageEnvironment:
     @abc.abstractmethod
     def compile(self, path: pathlib.Path, *, basedir: pathlib.Path, tempdir: pathlib.Path) -> None:
         """
@@ -20,7 +20,7 @@ def get_execute_command(self, path: pathlib.Path, *, basedir: pathlib.Path, temp
         raise NotImplementedError
 
 
-class Language(object):
+class Language:
     def list_attributes(self, path: pathlib.Path, *, basedir: pathlib.Path) -> Dict[str, Any]:
         """
         :throws Exception:

onlinejudge_verify/languages/python.py

@@ -56,8 +56,8 @@ def _python_list_depending_files(path: pathlib.Path, basedir: pathlib.Path) -> L
     res_graph = importlab.graph.ImportGraph.create(env, [str(path)])
     try:
         node_deps_pairs = res_graph.deps_list()  # type: List[Tuple[str, List[str]]]
-    except Exception:
-        raise RuntimeError(f"Failed to analyze the dependency graph (circular imports?): {path}")
+    except Exception as e:
+        raise RuntimeError(f"Failed to analyze the dependency graph (circular imports?): {path}") from e
     logger.debug('the dependency graph of %s: %s', str(path), node_deps_pairs)
 
     # collect Python files which are depended by the `path` and under `basedir`

onlinejudge_verify/main.py

@@ -7,7 +7,7 @@
     import onlinejudge.service
 except ModuleNotFoundError:
     print("Due to a known bug, the online-judge-tools is not yet properly installed. Please re-run $ pip3 install --force-reinstall online-judge-api-client")
-    exit(1)
+    exit(1)  # pylint: disable=consider-using-sys-exit
 # pylint: enable=unused-import,ungrouped-imports
 
 import argparse
@@ -99,7 +99,7 @@ def push_timestamp_to_branch() -> None:
     logger.info('$ git add %s && git commit && git push', str(path))
     if path.exists():
         subprocess.check_call(['git', 'add', str(path)])
-    if subprocess.run(['git', 'diff', '--quiet', '--staged']).returncode:
+    if subprocess.run(['git', 'diff', '--quiet', '--staged'], check=False).returncode:
         message = '[auto-verifier] verify commit {}'.format(os.environ['GITHUB_SHA'])
         subprocess.check_call(['git', 'commit', '-m', message])
         subprocess.check_call(['git', 'push', url, 'HEAD'])
@@ -149,7 +149,7 @@ def push_documents_to_gh_pages(*, src_dir: pathlib.Path, dst_branch: str = 'gh-p
     subprocess.check_call(['git', 'config', '--global', 'user.name', 'GitHub'])
     subprocess.check_call(['git', 'config', '--global', 'user.email', '[email protected]'])
     subprocess.check_call(['git', 'add', '.'])
-    if subprocess.run(['git', 'diff', '--quiet', '--staged']).returncode:
+    if subprocess.run(['git', 'diff', '--quiet', '--staged'], check=False).returncode:
         message = '[auto-verifier] docs commit {}'.format(os.environ['GITHUB_SHA'])
         subprocess.check_call(['git', 'commit', '-m', message])
         subprocess.check_call(['git', 'push', url, 'HEAD'])
@@ -219,7 +219,7 @@ def _delete_gitignore() -> None:
 
         # check if .verify-helper/.gitignore exists
         gitignore_path = pathlib.Path('.verify-helper', '.gitignore')
-        gitignore_checked_in = (subprocess.run(['git', 'ls-files', '--error-unmatch', str(gitignore_path)]).returncode == 0)
+        gitignore_checked_in = (subprocess.run(['git', 'ls-files', '--error-unmatch', str(gitignore_path)], check=False).returncode == 0)
         if not gitignore_checked_in:
             return
         logger.warning('file %s exists in this Git repository. It should not be checked in.', str(gitignore_path))