Merge pull request #24 from Linusp/pre-commit

setup pre-commit

Author: Linusp

.github/workflows/pre-commit.yaml

@@ -0,0 +1,14 @@
+name: Python package
+
+on:
+  pull_request:
+  push:
+    branches: [master]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/[email protected]

.github/workflows/pythonpackage.yml

@@ -62,4 +62,4 @@ ENV/
 
 # Spyder project settings
 .spyderproject
-.idea/*
+.idea/*

.gitignore

@@ -0,0 +1,58 @@
+fail_fast: true
+repos:
+  - repo: meta
+    hooks:
+      - id: check-hooks-apply
+      - id: check-useless-excludes
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.1.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-yaml
+      - id: end-of-file-fixer
+        exclude: |
+          (?x)(
+              .md$|
+              ^.gitignore|
+              ^.ipython/|
+              ^.pytest_cache/
+          )
+      - id: trailing-whitespace
+        exclude: |
+          (?x)(
+              .md$|
+              ^.ipython/|
+              ^.pytest_cache/
+          )
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/psf/black
+    rev: 22.6.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+        additional_dependencies:
+          - setuptools
+          - flake8-bugbear
+          - flake8-comprehensions
+          - flake8-debugger
+          - flake8-logging-format
+          - flake8-pytest-style
+          - flake8-tidy-imports
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.1.0
+    hooks:
+      - id: codespell
+        name: codespell
+        entry: codespell -q 3 -S "*.lock" -I codespell-ignore-words.txt --regex="[a-zA-Z0-9\-'’`]+"
+        types: [text]

.pre-commit-config.yaml

@@ -24,7 +24,6 @@
 
 
 class InoreaderClient(object):
-
     # paths
     TOKEN_PATH = '/oauth2/token'
     USER_INFO_PATH = 'user-info'
@@ -190,13 +189,11 @@ def fetch_articles(self, folder=None, tags=None, unread=True, starred=False, lim
         fetched_count = 0
         response = self.parse_response(self.session.post(url, params=params, proxies=self.proxies))
         for data in response['items']:
-            categories = set(
-                [
-                    category.split('/')[-1]
-                    for category in data.get('categories', [])
-                    if category.find('label') > 0
-                ]
-            )
+            categories = {
+                category.split('/')[-1]
+                for category in data.get('categories', [])
+                if category.find('label') > 0
+            }
             if tags and not categories.issuperset(set(tags)):
                 continue
 
@@ -212,13 +209,11 @@ def fetch_articles(self, folder=None, tags=None, unread=True, starred=False, lim
                 self.session.post(url, params=params, proxies=self.proxies)
             )
             for data in response['items']:
-                categories = set(
-                    [
-                        category.split('/')[-1]
-                        for category in data.get('categories', [])
-                        if category.find('label') > 0
-                    ]
-                )
+                categories = {
+                    category.split('/')[-1]
+                    for category in data.get('categories', [])
+                    if category.find('label') > 0
+                }
                 if tags and not categories.issuperset(set(tags)):
                     continue
                 yield Article.from_json(data)
@@ -305,6 +300,6 @@ def edit_subscription(self, stream_id, action, title=None, add_folder=None, remo
         response = self.parse_response(
             r,
             # self.session.post(url, params=params, proxies=self.proxies),
-            json_data=False
+            json_data=False,
         )
         return response

codespell-ignore-words.txt

@@ -95,7 +95,7 @@ def wrapper(*args, **kwargs):
     return wrapper
 
 
-@click.group(context_settings=dict(help_option_names=['-h', '--help']))
+@click.group(context_settings={'help_option_names': ['-h', '--help']})
 def main():
     pass
 
@@ -199,7 +199,7 @@ def list_tags():
 
 @main.command("fetch-unread")
 @click.option("-f", "--folder", required=True, help='Folder which articles belong to')
-@click.option("-t", "--tags", help="Tag(s) for filtering, seprate with comma")
+@click.option("-t", "--tags", help="Tag(s) for filtering, separate with comma")
 @click.option("-o", "--outfile", required=True, help="Filename to save articles")
 @click.option(
     "--out-format",
@@ -270,7 +270,7 @@ def apply_action(articles, client, action, tags):
     elif action == 'broadcast':
         client.broadcast(articles)
         for article in articles:
-            LOGGER.info("Boradcast article: %s", article.title)
+            LOGGER.info("Broadcast article: %s", article.title)
     elif action == 'star':
         client.mark_as_starred(articles)
         for article in articles:
@@ -362,7 +362,7 @@ def get_subscriptions(outfile, folder, out_format):
     client = get_client()
     results = []
     for sub in client.get_subscription_list():
-        sub_categories = set([category['label'] for category in sub.categories])
+        sub_categories = {category['label'] for category in sub.categories}
         if folder and folder not in sub_categories:
             continue
 
@@ -452,9 +452,7 @@ def dedupe(folder, thresh):
         for docid, doc, _ in related:
             if docid == article.id:
                 continue
-            sims[doc] = sim_of(
-                doc, article.title, method='cosine', term='char', ngram_range=(2, 3)
-            )
+            sims[doc] = sim_of(doc, article.title, method='cosine', term='char', ngram_range=(2, 3))
 
         if sims and max(sims.values()) >= thresh:
             top_doc, top_score = sims.most_common()[0]
@@ -470,7 +468,7 @@ def dedupe(folder, thresh):
 
 @main.command("fetch-starred")
 @click.option("-f", "--folder", help='Folder which articles belong to')
-@click.option("-t", "--tags", help="Tag(s) for filtering, seprate with comma")
+@click.option("-t", "--tags", help="Tag(s) for filtering, separate with comma")
 @click.option(
     "-o", "--outfile", help="Filename to save articles, required when output format is `csv`"
 )
@@ -587,10 +585,13 @@ def fetch_starred(folder, tags, outfile, outdir, limit, save_image, out_format):
 
 
 @main.command("edit-subscription")
-@click.option("-a", "--action",
-              required=True,
-              type=click.Choice(['follow', 'unfollow', 'rename', 'add-folder', 'remove-folder']),
-              help="")
+@click.option(
+    "-a",
+    "--action",
+    required=True,
+    type=click.Choice(['follow', 'unfollow', 'rename', 'add-folder', 'remove-folder']),
+    help="",
+)
 @click.option("-i", "--stream-id", required=True, help='Stream ID which you want to fetch')
 @click.option("-n", "--name", help='The name of subscription, for action follow/rename(required)')
 @click.option("-f", "--folder", help='Folder which subscription belong to')
@@ -616,11 +617,7 @@ def edit_subscriptions(action, stream_id, name, folder):
     remove_folder = folder if action == 'remove-folder' else None
     try:
         response = client.edit_subscription(
-            stream_id,
-            edit_action,
-            title=name,
-            add_folder=add_folder,
-            remove_folder=remove_folder
+            stream_id, edit_action, title=name, add_folder=add_folder, remove_folder=remove_folder
         )
         click.secho(response, fg="green")
     except Exception as exception:

inoreader/client.py

@@ -22,10 +22,10 @@ def make_terms(text, term, ngram_range=None, lower=True, ignore_punct=True, gram
     elif term == 'char':
         term_seq = list(re.sub(r'\s', '', text))
     else:
-        raise ValueError("unsupported term type: {}".foramt(term))
+        raise ValueError(f"unsupported term type: {term}")
 
     if ngram_range and not (len(ngram_range) == 2 and ngram_range[0] < ngram_range[1]):
-        raise ValueError("wrong `ngram_range`: {}".foramt(ngram_range))
+        raise ValueError(f"wrong `ngram_range`: {ngram_range}")
 
     terms = []
     min_ngram, max_ngram = ngram_range or (1, 2)
@@ -96,7 +96,7 @@ def cosine_sim(
             first_norm += freq**2
             inner_product += freq * second_term_freq[term]
 
-        for term, freq in second_term_freq.items():
+        for _, freq in second_term_freq.items():
             second_norm += freq**2
 
         if first_norm == 0 and second_norm == 0:

inoreader/main.py

@@ -18,7 +18,7 @@ def from_json(cls, data):
         subscription_info = {
             'id': data['id'],
             'title': data['title'],
-            'categories': [item for item in data['categories']],
+            'categories': list(data['categories']),
             'sortid': data['sortid'],
             'firstitemmsec': data['firstitemmsec'],
             'url': data['url'],

inoreader/sim.py

@@ -1,5 +1,5 @@
 [tool.black]
-line-length = 99
+line-length = 100
 skip-string-normalization = true
 extend-exclude = '''
 /(
@@ -22,6 +22,6 @@ include_trailing_comma = true
 force_grid_wrap = 0
 use_parentheses = true
 ensure_newline_before_comments = true
-line_length = 99
+line_length = 100
 skip = [".ipython"]
 remove_redundant_aliases = true