Feature/lintering #27

g3n35i5 · 2022-01-16T16:49:31Z

Running black and isort on the entire code base. This could be automated in future, e.g. by using tox or gh actions (in order to validate each commit / PR)

This resolves #26

codecov · 2022-01-17T15:10:38Z

Codecov Report

Merging #27 (3429ca7) into main (b6ca69c) will decrease coverage by 1.12%.
The diff coverage is 92.70%.

@@            Coverage Diff             @@
##             main      #27      +/-   ##
==========================================
- Coverage   93.67%   92.55%   -1.13%     
==========================================
  Files          44       44              
  Lines        2008     2014       +6     
  Branches      171      200      +29     
==========================================
- Hits         1881     1864      -17     
- Misses        107      129      +22     
- Partials       20       21       +1

Impacted Files	Coverage Δ
atpbar/presentation/detect/jupy.py	`84.61% <0.00%> (ø)`
tests/presentation/test_is_jupyter_notebook.py	`100.00% <ø> (ø)`
tests/test_version.py	`100.00% <ø> (ø)`
tests/scenarios/conftest.py	`73.68% <47.61%> (-10.53%)`	⬇️
atpbar/presentation/detect/spy.py	`66.66% <50.00%> (ø)`
atpbar/stream.py	`51.28% <66.66%> (ø)`
tests/scenarios/test_readme_mantichora.py	`42.85% <77.77%> (+1.39%)`	⬆️
atpbar/presentation/txtprint.py	`82.85% <83.33%> (+0.50%)`	⬆️
atpbar/presentation/base.py	`88.04% <84.61%> (ø)`
atpbar/main.py	`90.62% <87.50%> (ø)`
... and 40 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b6ca69c...3429ca7. Read the comment docs.

TaiSakuma

I made some comments inline and pushed some commits.

For imports under tests/, I order imports in a certain way: general modules, test-related modules (e.g., pytest, mock, and lastly from atpbar. Is it possible to configure isort in this way? Or otherwise can you not use isort on test files?

TaiSakuma · 2022-01-19T01:36:49Z

atpbar/__init__.py

 from ._version import get_versions
-__version__ = get_versions()['version']
+from .funcs import disable, find_reporter, flush, register_reporter
+from .main import atpbar
+
+__version__ = get_versions()["version"]
 del get_versions


Can you revert these lines to the original order?

The get_versions is used in this file and deleted while other imported objects are there to be imported by users' scripts.

TaiSakuma · 2022-01-19T01:40:22Z

atpbar/_version.py

@@ -1,4 +1,3 @@
-
 # This file helps to compute a version number in source trees obtained from


Please do not modify this file. This file is part of Versioneer is not managed in this repo.

TaiSakuma · 2022-01-19T01:45:32Z

setup.py

-            'ipywidgets>=7.5',
-        ]
-    }
+        "lintering": [


Please call this dev instead of lintering.

TaiSakuma · 2022-01-19T01:51:47Z

tests/presentation/test_base.py

-    pytest.param(
-        dict(taskid=1, last=False),
-        [ ], [ ], [ ], [ ],
-        [1], [ ], [ ], [ ],
-        True
-    ),
-    pytest.param(
-        dict(taskid=1, last=False),
-        [1], [ ], [ ], [ ],
-        [1], [ ], [ ], [ ],
-        True
-    ),
-    pytest.param(
-        dict(taskid=1, last=False),
-        [ ], [1], [ ], [ ],
-        [ ], [1], [ ], [ ],
-        True
-    ),
-    pytest.param(
-        dict(taskid=1, last=False),
-        [ ], [ ], [1], [ ],
-        [ ], [ ], [1], [ ],
-        True
-    ),
-    pytest.param(
-        dict(taskid=1, last=False),
-        [ ], [ ], [ ], [1],
-        [ ], [ ], [ ], [1],
-        False
-    ),
-
+    pytest.param(dict(taskid=1, last=False), [], [], [], [], [1], [], [], [], True),
+    pytest.param(dict(taskid=1, last=False), [1], [], [], [], [1], [], [], [], True),
+    pytest.param(dict(taskid=1, last=False), [], [1], [], [], [], [1], [], [], True),
+    pytest.param(dict(taskid=1, last=False), [], [], [1], [], [], [], [1], [], True),
+    pytest.param(dict(taskid=1, last=False), [], [], [], [1], [], [], [], [1], False),
    ##
-    pytest.param(
-        dict(taskid=1, last=True),
-        [ ], [ ], [ ], [ ],
-        [ ], [ ], [1], [ ],
-        True
-    ),
-    pytest.param(
-        dict(taskid=1, last=True),
-        [1], [ ], [ ], [ ],
-        [ ], [ ], [1], [ ],
-        True
-    ),
-    pytest.param(
-        dict(taskid=1, last=True),
-        [ ], [1], [ ], [ ],
-        [ ], [ ], [1], [ ],
-        True
-    ),
-    pytest.param(
-        dict(taskid=1, last=True),
-        [ ], [ ], [1], [ ],
-        [ ], [ ], [1], [ ],
-        True
-    ),
-    pytest.param(
-        dict(taskid=1, last=True),
-        [ ], [ ], [ ], [1],
-        [ ], [ ], [ ], [1],
-        False
-    ),


Please don't change these lines. You can add #fmt: on/off

TaiSakuma · 2022-01-19T01:52:08Z

tests/presentation/test_base.py

-        [ ], [ ], [ ], [ ],
-        [ ], [ ], [ ], [ ],
+        [],
+        [],
+        [],
+        [],
+        [],
+        [],
+        [],
+        [],
    ),
    pytest.param(
-        [ ], [10, 11, 12], [ ], [30, 31, 32],
-        [ ], [10, 11, 12], [ ], [30, 31, 32],
+        [],
+        [10, 11, 12],
+        [],
+        [30, 31, 32],
+        [],
+        [10, 11, 12],
+        [],
+        [30, 31, 32],
    ),
    pytest.param(
-        [1, 2], [10, 11, 12], [20, 21], [30, 31, 32],
-        [ ], [10, 11, 12, 1, 2], [ ], [30, 31, 32, 20, 21],
+        [1, 2],
+        [10, 11, 12],
+        [20, 21],
+        [30, 31, 32],
+        [],
+        [10, 11, 12, 1, 2],
+        [],
+        [30, 31, 32, 20, 21],


Please don't change these lines. You can add #fmt: on/off

TaiSakuma · 2022-01-19T01:55:46Z

tests/presentation/test_create_presentation.py

-    })
-    module = sys.modules['atpbar.presentation.create']
-    monkeypatch.setattr(module, 'sys', f)
+    f = mock.Mock(**{"stdout.isatty.return_value": ret, "stdout.write.side_effect": lambda x: org_stdout.write(x)})


Can you keep this as multiple lines? If you add a comma (,) after org_stdout.write(x), Black will keep it as multiple lines.

g3n35i5 added 3 commits January 16, 2022 17:11

Ignoring local venv and vscode settings

d51f49d

Running black and isort on codebase

c0b505b

Adding black and isort to extra requires

35c854a

TaiSakuma added 5 commits January 18, 2022 20:42

Update spy.py

bbc92ae

Update test_pickup.py

df0dc1c

Update test_multiprocessing.py

c2d3cdd

Update test_threading.py

eca3412

Update funcs.py

3429ca7

TaiSakuma requested changes Jan 19, 2022

View reviewed changes

TaiSakuma closed this May 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/lintering #27

Feature/lintering #27

g3n35i5 commented Jan 16, 2022

codecov bot commented Jan 17, 2022 •

edited

TaiSakuma left a comment

TaiSakuma Jan 19, 2022

TaiSakuma Jan 19, 2022

TaiSakuma Jan 19, 2022

TaiSakuma Jan 19, 2022

TaiSakuma Jan 19, 2022

TaiSakuma Jan 19, 2022

		@@ -1,4 +1,3 @@

		# This file helps to compute a version number in source trees obtained from

Feature/lintering #27

Feature/lintering #27

Conversation

g3n35i5 commented Jan 16, 2022

codecov bot commented Jan 17, 2022 • edited

Codecov Report

TaiSakuma left a comment

Choose a reason for hiding this comment

TaiSakuma Jan 19, 2022

Choose a reason for hiding this comment

TaiSakuma Jan 19, 2022

Choose a reason for hiding this comment

TaiSakuma Jan 19, 2022

Choose a reason for hiding this comment

TaiSakuma Jan 19, 2022

Choose a reason for hiding this comment

TaiSakuma Jan 19, 2022

Choose a reason for hiding this comment

TaiSakuma Jan 19, 2022

Choose a reason for hiding this comment

codecov bot commented Jan 17, 2022 •

edited