Add support for package and module in Pylint #100

JeanChristopheMorinPerso · 2019-02-28T02:40:38Z

Add support for package and module in Pylint.

In python, a project can look like:

src
└── package
    ├── __init__.py
    ├── sub_package1
    │   ├── __init__.py
    │   ├── module1.py
    │   └── module2.py
    └── sub_package2
        ├── __init__.py
        ├── module3.py
        └── module4.py

So if a file named __init__.py exists in a folder, python will consider that folder as a package (or sub-package, but it's the same as a package, so no big difference). And any file that ends in .py is called a module.

Since warnings-ng supports package and module, I decided to also add support for them in the pylint parser.

JeanChristopheMorinPerso · 2019-02-28T02:44:11Z

src/test/java/edu/hm/hafner/analysis/parser/PylintParserTest.java

+                    .hasCategory("W0611")
+                    .hasSeverity(Severity.WARNING_NORMAL)
+                    .hasModuleName("module_name_no_package")
+                    .hasPackageName(null);


This specific test fails and I have absolutely no idea why. If anyone have ideas, I'm all ear 👂
I'm not a Java developer, so I might be missing something obvious...

null is not possible. Seems that the parser returns the module name.

null is not allowed, use "-"

JeanChristopheMorinPerso · 2019-02-28T03:00:32Z

PS: I still have to check with other tools than Pylint if what I did is consistent.

uhafner · 2019-02-28T08:17:33Z

src/main/java/edu/hm/hafner/analysis/parser/PyLintParser.java

+            }
+            builder.setModuleName(moduleName);
+        }
+


Here you need:

else { builder.setPackageName("-").setModuleName("-"); }

The builder is not cleared between warnings.

Aaa, that confirms what I was seeing, effectively. I had the impression something wasn't cleared, but didn't knew what it was. I'll adjust this, thanks :)

uhafner · 2019-02-28T08:19:17Z

src/test/java/edu/hm/hafner/analysis/parser/PylintParserTest.java

+                    .hasCategory("W0611")
+                    .hasSeverity(Severity.WARNING_NORMAL)
+                    .hasModuleName("module_name_no_package")
+                    .hasPackageName(null);


null is not allowed, use "-"

codecov · 2019-03-02T18:06:03Z

Codecov Report

Merging #100 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##             master     #100      +/-   ##
============================================
+ Coverage     86.45%   86.48%   +0.02%     
- Complexity     1190     1192       +2     
============================================
  Files           159      159              
  Lines          3832     3840       +8     
  Branches        426      428       +2     
============================================
+ Hits           3313     3321       +8     
  Misses          357      357              
  Partials        162      162

Impacted Files	Coverage Δ	Complexity Δ
...va/edu/hm/hafner/analysis/parser/PyLintParser.java	`84% <100%> (+7.52%)`	`8 <0> (+2)`	⬆️

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 a117c9f...6c12eb1. Read the comment docs.

codecov · 2019-03-02T18:06:04Z

Codecov Report

Merging #100 into master will increase coverage by 0.02%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##             master     #100      +/-   ##
============================================
+ Coverage     86.45%   86.48%   +0.02%     
- Complexity     1190     1192       +2     
============================================
  Files           159      159              
  Lines          3832     3840       +8     
  Branches        426      428       +2     
============================================
+ Hits           3313     3321       +8     
  Misses          357      357              
  Partials        162      162

Impacted Files	Coverage Δ	Complexity Δ
...va/edu/hm/hafner/analysis/parser/PyLintParser.java	`84% <100%> (+7.52%)`	`8 <0> (+2)`	⬆️

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 a117c9f...38f0909. Read the comment docs.

JeanChristopheMorinPerso commented Feb 28, 2019

View reviewed changes

uhafner requested changes Feb 28, 2019

View reviewed changes

JeanChristopheMorinPerso added 2 commits March 2, 2019 10:28

Add support for package and module in Pylint

1845834

fix tests

6c12eb1

JeanChristopheMorinPerso force-pushed the dev_pylint_add_package_and_module branch from 01294c3 to 6c12eb1 Compare March 2, 2019 17:54

JeanChristopheMorinPerso force-pushed the dev_pylint_add_package_and_module branch from d30d72b to 38f0909 Compare March 2, 2019 18:14

Move else on new line

38f0909

JeanChristopheMorinPerso mentioned this pull request Mar 3, 2019

Pylint: add proper support for packages and modules jenkinsci/warnings-ng-plugin#15

Merged

uhafner approved these changes Mar 3, 2019

View reviewed changes

uhafner merged commit eaadd8b into jenkinsci:master Mar 3, 2019

JeanChristopheMorinPerso deleted the dev_pylint_add_package_and_module branch March 3, 2019 17:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for package and module in Pylint #100

Add support for package and module in Pylint #100

JeanChristopheMorinPerso commented Feb 28, 2019

JeanChristopheMorinPerso Feb 28, 2019

uhafner Feb 28, 2019

uhafner Feb 28, 2019

JeanChristopheMorinPerso commented Feb 28, 2019

uhafner Feb 28, 2019

uhafner Feb 28, 2019

JeanChristopheMorinPerso Feb 28, 2019

JeanChristopheMorinPerso Mar 2, 2019

uhafner Feb 28, 2019

codecov bot commented Mar 2, 2019

codecov bot commented Mar 2, 2019 •

edited

Loading

Add support for package and module in Pylint #100

Add support for package and module in Pylint #100

Conversation

JeanChristopheMorinPerso commented Feb 28, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JeanChristopheMorinPerso commented Feb 28, 2019

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

Choose a reason for hiding this comment

codecov bot commented Mar 2, 2019

Codecov Report

codecov bot commented Mar 2, 2019 • edited Loading

Codecov Report

codecov bot commented Mar 2, 2019 •

edited

Loading