Upgrade tox and linter to conventions used by other projects by f4str · Pull Request #831 · Kitware/dive

f4str · 2021-07-08T15:02:44Z

Updated tox to use flake8 for the linter and changed black and isort configurations to match linting and styling conventions used by all other projects for consistency (most noticeably changing line-length from 88 to 100).

mypy's newest release allows configurations to be stored in pyproject.toml instead of requiring its own mypy.ini.

Cleaned up the setup.py dev requirements as they are no longer needed since tox will automatically install them in a virtualenv wrapper when needed.

All changes made are purely linting fixes (most of which are by black and isort auto-formatting) such as:

removing unused imports
removing unused variables
docstring capitalization/formatting
changing type annotations
consolidating/expanding code into less/more lines

…x-upgrade

subdavis · 2021-07-13T13:06:55Z

server/pyproject.toml

-use_parentheses = true
-include_trailing_comma = true
-multi_line_output = 3
+profile = "black"


This was like the greatest addition to isort ever.

subdavis

Please fix string literal line wraps. Everything else looks good!

subdavis · 2021-07-13T13:09:41Z

server/tests/test_deserialize_viame_csv.py

+            "2,3.png,2,10,50,20,35,1,-1,type3,0.765,(kp) head 22.4534 45.6564,"
+            "(kp) tail 55.232 22.3445",


I don't think this is OK style. Could you either come up with a way to let these string literals span their full width? I don't even care if you have to disable this rule for this file, this makes the code harder to read IMO.

should the content for these tests be moved to ./testutils and loaded in like for the image-sort. Then you no longer are worrying about linting and formatting test data? You may lose the in-line comments though.

They're paired input/expected, so you'd have to organize them as such.

I don't feel that strongly about it, but even if you moved these, you still couldn't have str literals longer than 100chars, which as a concept I would like to resolve.

subdavis · 2021-07-13T13:09:50Z

server/tests/test_deserialize_viame_csv.py

+            "0,1.png,0,884.66,510,1219.66,737.66,1,-1,typestring,1,(atr) DetectionNumber 2.002,"
+            "(atr) DetectionPredefinedValue value1",
+            "0,2.png,1,111,222,3333,444,1,-1,typestring,1,(trk-atr) booleanAttr true,"
+            "(atr) DetectionPredefinedValue value2",
+            "0,3.png,2,747,457,1039,633,1,-1,typestring,1,(trk-atr) booleanAttr true,"
+            "(atr) DetectionPredefinedValue value3",
+            "0,3.png,3,884.66,510,1219.66,737.66,1,-1,typestring,1,(trk-atr) booleanAttr true,"
+            "(atr) DetectionPredefinedValue value1",
            "0,4.png,4,111,222,3333,444,1,-1,typestring,1,(atr) DetectionPredefinedValue value2",
            "0,5.png,5,747,457,1039,633,1,-1,typestring,1,(atr) DetectionPredefinedValue value3",
-            "1,1.png,0,884.66,510,1219.66,737.66,1,-1,typestring,1,(atr) DetectionNumber 2.002,(atr) DetectionPredefinedValue value1",
-            "1,2.png,1,111,222,3333,444,1,-1,typestring,1,(trk-atr) booleanAttr true,(atr) DetectionPredefinedValue value2",
-            "1,3.png,2,747,457,1039,633,1,-1,typestring,1,(trk-atr) booleanAttr true,(atr) DetectionPredefinedValue value3",
-            "1,3.png,3,884.66,510,1219.66,737.66,1,-1,typestring,1,(trk-atr) booleanAttr true,(atr) DetectionPredefinedValue value1",
+            "1,1.png,0,884.66,510,1219.66,737.66,1,-1,typestring,1,(atr) DetectionNumber 2.002,"
+            "(atr) DetectionPredefinedValue value1",
+            "1,2.png,1,111,222,3333,444,1,-1,typestring,1,(trk-atr) booleanAttr true,"
+            "(atr) DetectionPredefinedValue value2",
+            "1,3.png,2,747,457,1039,633,1,-1,typestring,1,(trk-atr) booleanAttr true,"
+            "(atr) DetectionPredefinedValue value3",
+            "1,3.png,3,884.66,510,1219.66,737.66,1,-1,typestring,1,(trk-atr) booleanAttr true,"
+            "(atr) DetectionPredefinedValue value1",


subdavis · 2021-07-13T13:09:55Z

server/tests/test_deserialize_viame_csv.py

+            "5,6.png,6,10,10,20,20,1,-1,type1,0.89,(atr) attrNAME spaced attr name,"
+            "(trk-atr) booleanAttr true",


subdavis · 2021-07-13T13:10:01Z

server/tests/test_serialize_viame_csv.py

+            "0,1.png,0,884,510,1219,737,1.0,-1,typestring,1.0,(atr) detectionAttr frame 0 attr,"
+            "(trk-atr) trackATTR TestTrack ATTR With Space",
+            "0,2.png,1,111,222,3333,444,1.0,-1,typestring,1.0,(atr) detectionAttr frame 1 attr,"
+            "(trk-atr) trackATTR TestTrack ATTR With Space",


f4str · 2021-07-13T18:09:43Z

Fixed the string wrapping and added the flake8 config to ignore line length linting for tests/

Also added the tox -e docs option to run mkdocs and serve the site. Thus mkdocs was removed from the dev requirements since tox will automatically install it. This is documented in server/README.md

Finally changed the version number in server/setup.py to match client/package.json.

Farhan Ahmed added 6 commits June 30, 2021 11:09

moved mypy.ini to pyproject.toml and added flake8 linter

bf11a0f

Merge branch 'main' of https://github.com/Kitware/dive into server/to…

7c18d9b

…x-upgrade

Fixed various linting issues

b209fe2

Updated black and isort to conventions used by other projects

ec1189f

Fixed all remaining linting issues

1d46ccf

Re-added mypy type checks for viame serializer

decd157

f4str changed the title ~~Upgrade tox and liner to conventions used by other projects~~ Upgrade tox and linter to conventions used by other projects Jul 8, 2021

cleaned up dev requirements in setup.py

49221cf

f4str marked this pull request as ready for review July 9, 2021 15:13

f4str requested review from BryonLewis and subdavis July 9, 2021 15:23

Merge branch 'main' of https://github.com/Kitware/dive into server/to…

f8692ff

…x-upgrade

subdavis reviewed Jul 13, 2021

View reviewed changes

subdavis suggested changes Jul 13, 2021

View reviewed changes

Farhan Ahmed added 2 commits July 13, 2021 13:26

fixed string literal wraps in tests

90221c0

added tox docs option and cleaned up setup.py

33816b7

subdavis approved these changes Jul 13, 2021

View reviewed changes

f4str merged commit bae0650 into main Jul 13, 2021

f4str deleted the server/tox-upgrade branch July 13, 2021 18:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade tox and linter to conventions used by other projects#831

Upgrade tox and linter to conventions used by other projects#831
f4str merged 10 commits intomainfrom
server/tox-upgrade

f4str commented Jul 8, 2021 •

edited

Loading

Uh oh!

subdavis Jul 13, 2021

Uh oh!

subdavis left a comment

Uh oh!

subdavis Jul 13, 2021

Uh oh!

BryonLewis Jul 13, 2021 •

edited

Loading

Uh oh!

subdavis Jul 13, 2021

Uh oh!

subdavis Jul 13, 2021

Uh oh!

subdavis Jul 13, 2021

Uh oh!

subdavis Jul 13, 2021

Uh oh!

f4str commented Jul 13, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		"2,3.png,2,10,50,20,35,1,-1,type3,0.765,(kp) head 22.4534 45.6564,"
		"(kp) tail 55.232 22.3445",

		"5,6.png,6,10,10,20,20,1,-1,type1,0.89,(atr) attrNAME spaced attr name,"
		"(trk-atr) booleanAttr true",

Conversation

f4str commented Jul 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

subdavis Jul 13, 2021

Choose a reason for hiding this comment

Uh oh!

subdavis left a comment

Choose a reason for hiding this comment

Uh oh!

subdavis Jul 13, 2021

Choose a reason for hiding this comment

Uh oh!

BryonLewis Jul 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

subdavis Jul 13, 2021

Choose a reason for hiding this comment

Uh oh!

subdavis Jul 13, 2021

Choose a reason for hiding this comment

Uh oh!

subdavis Jul 13, 2021

Choose a reason for hiding this comment

Uh oh!

subdavis Jul 13, 2021

Choose a reason for hiding this comment

Uh oh!

f4str commented Jul 13, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

f4str commented Jul 8, 2021 •

edited

Loading

BryonLewis Jul 13, 2021 •

edited

Loading