Added undescore to ignore new pydocstyle item #428

Crola1702 · 2023-01-03T15:58:08Z

Signed-off-by: Crola1702 cristobal.arroyo@ekumenlabs.com

Pydocstyle 6.2.0 introduced a new feature where get_files_to_check method yields 4 items instead of 3.

This PR adds and ignores that item, so the tests can run without crashing.

Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com>

Crola1702 · 2023-01-03T16:07:01Z

Rolling CI is installing Pydocstyle 6.1.1:

00:01:00.043 pydocstyle: 6.1.1-1

Crola1702 · 2023-01-03T16:08:24Z

CI:

Linux
Linux-aarch64
Windows

Linux CI is upgrading to 6.2.1

Collecting pydocstyle
  Downloading pydocstyle-6.2.1-py3-none-any.whl (37 kB)
Collecting pyflakes
  Downloading pyflakes-3.0.1-py2.py3-none-any.whl (62 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.8/62.8 KB 11.4 MB/s eta 0:00:00
...
pydocstyle==6.2.1

clalancette · 2023-01-03T16:19:31Z

ament_pep257/ament_pep257/main.py

@@ -187,7 +187,7 @@ def generate_pep257_report(paths, excludes, ignore, select, convention, add_igno
    report = []

    files_dict = {}
-    for filename, checked_codes, ignore_decorators in files_to_check:
+    for filename, checked_codes, ignore_decorators, _ in files_to_check:


So this isn't going to work with older pydocstyle, which we still need to support for users who haven't upgraded the pydocstyle yet.

Instead, I think we'll need to first try to unpack 3 values, and if that fails with a ValueError, then try to unpack with 4 values. Alternatively, we could look up the version number of pydocstyle that is currently in use, and choose which one to do based on that (though I think that is a little more brittle).

Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com>

clalancette · 2023-01-03T16:45:28Z

ament_pep257/ament_pep257/main.py

+    # Unpack 3 values for pydocstyle <= 6.1.1
+    try:
+        for filename, checked_codes, ignore_decorators in files_to_check:
+            if _filename_in_excludes(filename, excludes):
+                continue
+            files_dict[filename] = {
+                'select': checked_codes,
+                'ignore_decorators': ignore_decorators,
+            }
+    # Unpack 4 values since pydocstyle >= 6.2.0
+    except ValueError:
+        for filename, checked_codes, ignore_decorators, _ in files_to_check:
+            if _filename_in_excludes(filename, excludes):
+                continue
+            files_dict[filename] = {
+                'select': checked_codes,
+                'ignore_decorators': ignore_decorators,
+            }


This definitely works, but duplicates the body of the loop.

I actually just learned about a new Python 3 syntax that lets you unpack an optional set of arguments at the end, *_. So I think we can handle returning 3 or 4 tuple items, without duplicating the body of the loop, with:

Suggested change

# Unpack 3 values for pydocstyle <= 6.1.1

try:

for filename, checked_codes, ignore_decorators in files_to_check:

if _filename_in_excludes(filename, excludes):

continue

files_dict[filename] = {

'select': checked_codes,

'ignore_decorators': ignore_decorators,

}

# Unpack 4 values since pydocstyle >= 6.2.0

except ValueError:

for filename, checked_codes, ignore_decorators, _ in files_to_check:

if _filename_in_excludes(filename, excludes):

continue

files_dict[filename] = {

'select': checked_codes,

'ignore_decorators': ignore_decorators,

}

# Unpack 3 values for pydocstyle <= 6.1.1, and 4 values for pydocstyle >= 6.2.0.

for filename, checked_codes, ignore_decorators, *_ in files_to_check:

if _filename_in_excludes(filename, excludes):

continue

files_dict[filename] = {

'select': checked_codes,

'ignore_decorators': ignore_decorators,

}

Can you give this a try and see if it still solves the problem?

Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com>

clalancette

Looks good with green CI!

Please make sure to run CI up to some package that uses ament_pep257, as well as on RHEL (to make sure it still works there).

Crola1702 · 2023-01-03T17:51:38Z

CI:

Linux
Linux-aarch64
Windows
Rhel

clalancette · 2023-01-03T21:57:32Z

This is all green, so merging this in.

clalancette · 2023-01-06T13:36:50Z

@Mergifyio backport humble

* Added underscore to ignore new item Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com> (cherry picked from commit ae431ed)

mergify · 2023-01-06T13:37:28Z

backport humble

✅ Backports have been created

#429 Added undescore to ignore new pydocstyle item (backport #428) has been created for branch humble

* Added underscore to ignore new item Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com> (cherry picked from commit ae431ed) Signed-off-by: Audrow Nash <audrow@openrobotics.org>

* Added underscore to ignore new item Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com> (cherry picked from commit ae431ed) Signed-off-by: Audrow Nash <audrow@openrobotics.org> Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com> Signed-off-by: Audrow Nash <audrow@openrobotics.org> Co-authored-by: Cristóbal Arroyo <69475004+Crola1702@users.noreply.github.com>

Crola1702 · 2023-01-12T14:29:58Z

@mergify backport foxy

mergify · 2023-01-12T14:30:30Z

backport foxy

❌ Command disallowed due to command restrictions in the Mergify configuration.

sender-permission>=write

clalancette · 2023-01-12T14:35:57Z

@Mergifyio backport foxy

* Added underscore to ignore new item Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com> (cherry picked from commit ae431ed) # Conflicts: # ament_pep257/ament_pep257/main.py

mergify · 2023-01-12T14:36:38Z

backport foxy

✅ Backports have been created

#431 Added undescore to ignore new pydocstyle item (backport #428) has been created for branch foxy

* Added underscore to ignore new pydocstyle item (#428) * Added underscore to ignore new item Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com> (cherry picked from commit ae431ed)

ijnek · 2023-03-03T05:08:45Z

Could we get a release in foxy so we can get this change please? I believe everyone's foxy CIs for ros2 python packages are failing without this change right now. Thanks!

Crola1702 · 2023-03-03T18:37:46Z

Could we please get a release in foxy so we can get this change please?

FYI: @jacobperron

clalancette · 2023-03-06T12:57:11Z

I'll comment over on the backport PR.

Added undescore to ignore new item

60f4fe7

Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com>

Crola1702 requested a review from mjeronimo as a code owner January 3, 2023 15:58

clalancette requested changes Jan 3, 2023

View reviewed changes

Support pydocstyle <= 6.1.1 and >= 6.2.0

98c54fc

Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com>

Crola1702 requested review from clalancette and removed request for mjeronimo January 3, 2023 16:35

clalancette requested changes Jan 3, 2023

View reviewed changes

Crola1702 added 3 commits January 3, 2023 11:52

Refactor pydocstyle items unpacking

9283b07

Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com>

Remove tab

8a43cea

Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com>

Remove space

b457c44

Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com>

Crola1702 requested a review from clalancette January 3, 2023 16:58

clalancette approved these changes Jan 3, 2023

View reviewed changes

clalancette mentioned this pull request Jan 3, 2023

Add in a fix for older compilers. ros2/rclcpp#2075

Merged

clalancette merged commit ae431ed into ament:rolling Jan 3, 2023

clalancette mentioned this pull request Jan 6, 2023

add pydocstyle version constraint ros2/ci#688

Closed

mergify bot pushed a commit that referenced this pull request Jan 6, 2023

Added underscore to ignore new pydocstyle item (#428)

fd5c6ab

* Added underscore to ignore new item Signed-off-by: Crola1702 <cristobal.arroyo@ekumenlabs.com> (cherry picked from commit ae431ed)

mergify bot mentioned this pull request Jan 6, 2023

Added undescore to ignore new pydocstyle item (backport #428) #429

Merged

mergify bot mentioned this pull request Jan 12, 2023

Added undescore to ignore new pydocstyle item (backport #428) #431

Merged

ijnek mentioned this pull request Jan 14, 2023

Fix installation of message folder ros-sports/soccer_ipm#7

Merged

This was referenced Jan 29, 2023

Remove Galactic since it is EOL ros-tooling/action-ros-ci#790

Merged

Bump package versions in tests ros-tooling/action-ros-ci#791

Merged

Add GitHub CI config ros-tracing/tracetools_analysis#3

Merged

christophebedard mentioned this pull request Feb 13, 2023

Pep 257 test fails with internal error on rolling ros-tooling/action-ros-ci#795

Closed

esteve mentioned this pull request Feb 27, 2023

Workaround for ament_lint issues. Run CI every night. ros2-rust/ros2_rust#302

Merged

christophebedard mentioned this pull request May 31, 2023

Test failure on Galactic ros-tooling/action-ros-ci#825

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added undescore to ignore new pydocstyle item #428

Added undescore to ignore new pydocstyle item #428

Crola1702 commented Jan 3, 2023

Crola1702 commented Jan 3, 2023

Crola1702 commented Jan 3, 2023

clalancette Jan 3, 2023

clalancette Jan 3, 2023

clalancette left a comment

Crola1702 commented Jan 3, 2023

clalancette commented Jan 3, 2023

clalancette commented Jan 6, 2023

mergify bot commented Jan 6, 2023

Crola1702 commented Jan 12, 2023

mergify bot commented Jan 12, 2023

clalancette commented Jan 12, 2023

mergify bot commented Jan 12, 2023

ijnek commented Mar 3, 2023 •

edited

Loading

Crola1702 commented Mar 3, 2023

clalancette commented Mar 6, 2023

Added undescore to ignore new pydocstyle item #428

Added undescore to ignore new pydocstyle item #428

Conversation

Crola1702 commented Jan 3, 2023

Crola1702 commented Jan 3, 2023

Crola1702 commented Jan 3, 2023

clalancette Jan 3, 2023

Choose a reason for hiding this comment

clalancette Jan 3, 2023

Choose a reason for hiding this comment

clalancette left a comment

Choose a reason for hiding this comment

Crola1702 commented Jan 3, 2023

clalancette commented Jan 3, 2023

clalancette commented Jan 6, 2023

mergify bot commented Jan 6, 2023

✅ Backports have been created

Crola1702 commented Jan 12, 2023

mergify bot commented Jan 12, 2023

❌ Command disallowed due to command restrictions in the Mergify configuration.

clalancette commented Jan 12, 2023

mergify bot commented Jan 12, 2023

✅ Backports have been created

ijnek commented Mar 3, 2023 • edited Loading

Crola1702 commented Mar 3, 2023

clalancette commented Mar 6, 2023

ijnek commented Mar 3, 2023 •

edited

Loading