[AT-4082] Configure pylint for catalog #549

seedlit · 2024-03-04T15:30:36Z

Jira ticket here.

Scope:

Fixes catalog.py and test_catalog.py for pylint

NOTES:

I had to make some changes in other files as well because of renaming a function name
We have to be careful with this release since I have renamed a function --> this might be a breaking change
most lines of changes are coming from poetry.lock file
I did not change the max line length setting to 79 yet as this will need changes in multiple files. Will make a separate PR for that.

Items:

For release:

Bumped version
Added changelog
Updated announcement banner

andher1802 · 2024-03-05T08:43:17Z

CHANGELOG.md

@@ -30,6 +30,12 @@ You can check your current version with the following command:

 For more information, see [UP42 Python package description](https://pypi.org/project/up42-py/).

+## 0.37.0a0


check the order of merging as the other PR has the same version bump

I'll address that in my PR if this is merged earlier

I updated it to 0.37.0a1

andher1802 · 2024-03-05T08:47:32Z

tests/test_catalog.py

@@ -1,19 +1,18 @@
 import json
 import os
+import pathlib


Just for curiosity, Why did we make this change?

Google style code

up42-py/pyproject.toml

Line 52 in e0e0e13

pylint-google-style-guide-imports-enforcing = "^1.3.0"

andher1802 · 2024-03-05T08:57:45Z

I check on the surface. Although I found it OK, I will leave the approval for @javidq.
However, I have two comments:

Usually I try to get 100% coverage for new code in every PR to not add more uncovered lines. This one changed 2 lines on catalog that are not covered by testing. Maybe adding test for catalog repr and the search with json features set to false would be nice if you think is OK.
Most of the changes were introduced at the import convention. Just for my own education, why some of them removed from x import y, and why some were left that way. Is there a rule that we are following or pylint enforces?

It LGTM. good job @seedlit , this one is a massive change. :)

javidq · 2024-03-05T12:38:48Z

pylintrc

-max-line-length=120
+
+# Maximum number of characters on a single line.
+max-line-length=150


We actually need to decrease, not increase

@seedlit this suggestion led to explosive growth of the PR and also security gate now fails due to coverage, let's just keep it 120 as it was and let's add a ticket to address it later separately. Sorry for confusion and unneeded work.

I will create a ticket.
Although I find it surprising that coverage got reduced just because of this setting.
Doesn't makes much sense 🤔

https://up42.atlassian.net/browse/AT-4887

It reduced because it basically checked all files, so now it shows the coverage of the whole SDK

.pre-commit-config.yaml

up42/catalog.py

javidq · 2024-03-05T12:55:54Z

tests/test_catalog.py

@@ -1,19 +1,18 @@
 import json
 import os
+import pathlib


Google style code

tests/test_catalog.py

javidq · 2024-03-05T14:02:54Z

CHANGELOG.md

@@ -30,6 +30,12 @@ You can check your current version with the following command:

 For more information, see [UP42 Python package description](https://pypi.org/project/up42-py/).

+## 0.37.0a0


I'll address that in my PR if this is merged earlier

up42/tasking.py

up42/catalog.py

tests/test_catalog.py

sonarcloud · 2024-03-06T16:33:15Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
97.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

seedlit · 2024-03-06T16:34:39Z

@dustgalactic I pushed your suggested changes.
I will merge this PR. If you have any other suggestions, I can tackle that in upcoming PRs

seedlit added 7 commits March 4, 2024 16:04

pylint: catalog initial commit

835fb0d

rename _request to request

edf48ac

add google style pylint imports

5fe2aca

fix imports

b9f3e6a

rename variable and fix tests

1465f56

fix imports

5463329

udate version and add changelog entry

e0e0e13

seedlit requested review from javidq and andher1802 March 4, 2024 16:20

andher1802 reviewed Mar 5, 2024

View reviewed changes

javidq requested changes Mar 5, 2024

View reviewed changes

seedlit added 10 commits March 5, 2024 15:58

PR comment: revert auth_instance to auth

6618f96

PR comments: variable names

a34eacc

set black's max line length setting to 80

d2f42cf

fix line too long for catalog.py

14adb11

fix line too long for test_catalog.py

fb70305

set max length to 80

f0af063

revert the max length setting to 120

8489b5c

update version

6bdf8d1

Merge branch 'master' into configure_pylint_for_catalog

9e6300a

use pylintrc to specify files; fix fixtures_catalog.py

efe3569

seedlit mentioned this pull request Mar 6, 2024

[AT-4081] Configure pylint for tasking #551

Merged

8 tasks

seedlit requested a review from dustgalactic March 6, 2024 14:13

javidq requested changes Mar 6, 2024

View reviewed changes

seedlit added 4 commits March 6, 2024 15:54

address comments

2849e09

Merge branch 'master' into configure_pylint_for_catalog

1b81a4f

bump version

ad3715e

fix test_session.py

756438b

javidq requested changes Mar 6, 2024

View reviewed changes

tests/test_catalog.py Outdated Show resolved Hide resolved

tests/test_catalog.py Outdated Show resolved Hide resolved

tests/test_catalog.py Outdated Show resolved Hide resolved

seedlit added 2 commits March 6, 2024 17:12

PR suggestions

a0832fc

remove parenthesis

eb072ab

javidq approved these changes Mar 6, 2024

View reviewed changes

update changelog

8db21a5

seedlit merged commit 9747d52 into master Mar 6, 2024
3 checks passed

seedlit deleted the configure_pylint_for_catalog branch March 6, 2024 16:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[AT-4082] Configure pylint for catalog #549

[AT-4082] Configure pylint for catalog #549

seedlit commented Mar 4, 2024 •

edited

Loading

andher1802 Mar 5, 2024

javidq Mar 5, 2024

seedlit Mar 6, 2024 •

edited

Loading

andher1802 Mar 5, 2024

javidq Mar 5, 2024

seedlit Mar 5, 2024

andher1802 commented Mar 5, 2024

javidq Mar 5, 2024

javidq Mar 6, 2024

seedlit Mar 6, 2024

seedlit Mar 6, 2024

javidq Mar 6, 2024 •

edited

Loading

javidq Mar 5, 2024

javidq Mar 5, 2024

sonarcloud bot commented Mar 6, 2024

seedlit commented Mar 6, 2024

		@@ -30,6 +30,12 @@ You can check your current version with the following command:

		For more information, see [UP42 Python package description](https://pypi.org/project/up42-py/).

		## 0.37.0a0

[AT-4082] Configure pylint for catalog #549

[AT-4082] Configure pylint for catalog #549

Conversation

seedlit commented Mar 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

seedlit Mar 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andher1802 commented Mar 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

javidq Mar 6, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Mar 6, 2024

Quality Gate passed

seedlit commented Mar 6, 2024

seedlit commented Mar 4, 2024 •

edited

Loading

seedlit Mar 6, 2024 •

edited

Loading

javidq Mar 6, 2024 •

edited

Loading