Auto-Linting: Spelling Black Style Checker #2800

mrmundt · 2023-04-10T14:30:12Z

Fixes #329

Summary/Motivation:

Finally, this is the PR that adds in the auto-linting pre-req for the regular testing suite.

Changes proposed in this PR:

Spell checker (with correctly spelled but falsely identified words represented in .github/workflows/typos.toml
Black style checker (current version: 23.3.0 - which adds some extra spaces between classes/functions. Ignores the examples/pyomobook/python-ch/BadIndent.py file as it is intentionally wrong)
Introduces the .git-blame-ignore-revs file which can be used to ignore all of the black style changes when running a git blame command:
1. git blame --ignore-revs-file .git-blame-ignore-revs
2. git config blame.ignoreRevsFile .git-blame-ignore-revs

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

I agree my contributions are submitted under the BSD license.
I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

jsiirola

Just a couple minor edits

pyomo/contrib/pynumero/sparse/block_matrix.py

pyomo/contrib/pyros/tests/test_grcs.py

pyomo/core/base/range.py

pyomo/mpec/complementarity.py

pyomo/solvers/plugins/solvers/direct_or_persistent_solver.py

codecov · 2023-04-10T18:25:06Z

Codecov Report

Patch coverage: 78.72% and no project coverage change.

Comparison is base (f723680) 87.00% compared to head (4851561) 87.01%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2800   +/-   ##
=======================================
  Coverage   87.00%   87.01%           
=======================================
  Files         763      763           
  Lines       87213    87213           
=======================================
+ Hits        75881    75886    +5     
+ Misses      11332    11327    -5

Flag	Coverage Δ
linux	`84.02% <78.26%> (+<0.01%)`	⬆️
osx	`73.52% <45.65%> (ø)`
other	`84.20% <78.26%> (ø)`
win	`81.53% <78.26%> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
examples/dae/simulator_ode_multindex_example.py	`62.71% <ø> (ø)`
examples/gdp/eight_process/eight_proc_logical.py	`91.13% <ø> (ø)`
examples/gdp/jobshop.py	`88.88% <ø> (ø)`
examples/gdp/small_lit/nonconvex_HEN.py	`67.56% <ø> (ø)`
examples/kernel/piecewise_nd_functions.py	`55.42% <ø> (ø)`
examples/kernel/special_ordered_sets.py	`100.00% <ø> (ø)`
examples/pyomo/core/t1.py	`100.00% <ø> (ø)`
examples/pyomo/core/t5.py	`100.00% <ø> (ø)`
examples/pyomo/piecewise/convex.py	`100.00% <ø> (ø)`
examples/pyomo/piecewise/indexed.py	`100.00% <ø> (ø)`
... and 130 more

... and 73 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Robbybp

I went through the contrib files and noted a few places where user code could break. I'm still in favor of merging, just making sure people are aware.

Robbybp · 2023-04-10T20:45:15Z

pyomo/contrib/parmest/scenariocreator.py

-    def ScenariosFromBoostrap(self, addtoSet, numtomake, seed=None):
+    def ScenariosFromBootstrap(self, addtoSet, numtomake, seed=None):


This could break a user's code, right? Should a deprecation path be added?

Robbybp · 2023-04-10T20:46:34Z

pyomo/contrib/parmest/scenariocreator.py

-            name = "Boostrap" + str(index)
+            name = "Bootstrap" + str(index)


Is this name used anywhere?

Robbybp · 2023-04-10T20:52:59Z

pyomo/contrib/preprocessing/plugins/constraint_tightener.py

-class TightenContraintFromVars(IsomorphicTransformation):
+class TightenConstraintFromVars(IsomorphicTransformation):


This could potentially break a user's code, although TransformationFactory would be the usual way to construct this object, which doesn't change, and the transformation is already deprecated.

mrmundt added 28 commits March 28, 2023 13:20

Set up git-blame-ignore file

9797d78

Add black linting action

c4049ca

Adjust contrib docs for black/spell check expectations

0711e9b

Add false typos and ignore a file type

fd4ac65

Fix typos in all dirs to which black has been applied already

7e4e9d8

Add SHA for black/contrib

20a13ee

Merge branch 'main' into auto-linting

b71d93c

Merging main

02cc89d

Apply typo fixes to contrib

e1ab4b4

Reapply black to some dual modified files

7643cd4

Temporarily turn off linting to verify changes

6a11bc0

Manually correct missed typos

2260088

Merge branch 'main' into auto-linting

99da28a

Apply typo correctionss post DAE/Network black merge

8718b94

Merge remote-tracking branch 'origin' into auto-linting

d5ee11c

Apply typo fixes and last pass at black formatting

2467e1b

Turn black linting on for PRs

496d212

Change black arguments

d636562

Apply black to residual examples aftering converting to Python3

1efee90

Look at file directory

5b23296

Lock black to v22.6

8e17205

Apply black 23.3.0 - adding white space

363a16a

Unpin black version

596c3b0

Merge branch 'main' into auto-linting

be5c46d

Add mass black reapplication to ignore list

a294ef4

Update instructions for local configuration, not global

f0a8a45

Fix CHANGELOG line to reflect typo change

1449ba7

Update contributer's guide with full black command

59aaeb9

mrmundt requested review from jsiirola and Robbybp April 10, 2023 14:30

mrmundt requested review from emma58 and blnicho April 10, 2023 14:30

mrmundt added 2 commits April 10, 2023 08:38

Residual awkward line combinations from black

709b9a6

Apply black change

607be28

jsiirola requested changes Apr 10, 2023

View reviewed changes

Apply comments per @jsiirola

a479ec2

mrmundt requested a review from jsiirola April 10, 2023 16:43

Standardization of word usage

4851561

jsiirola approved these changes Apr 10, 2023

View reviewed changes

mrmundt merged commit 5a9cc2e into Pyomo:main Apr 10, 2023

Robbybp approved these changes Apr 10, 2023

View reviewed changes

mrmundt deleted the auto-linting branch July 25, 2023 17:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Auto-Linting: Spelling Black Style Checker #2800

Auto-Linting: Spelling Black Style Checker #2800

mrmundt commented Apr 10, 2023

jsiirola left a comment

codecov bot commented Apr 10, 2023

Robbybp left a comment

Robbybp Apr 10, 2023

Robbybp Apr 10, 2023

Robbybp Apr 10, 2023

		def ScenariosFromBoostrap(self, addtoSet, numtomake, seed=None):
		def ScenariosFromBootstrap(self, addtoSet, numtomake, seed=None):

		name = "Boostrap" + str(index)
		name = "Bootstrap" + str(index)

		class TightenContraintFromVars(IsomorphicTransformation):
		class TightenConstraintFromVars(IsomorphicTransformation):

Auto-Linting: Spelling Black Style Checker #2800

Auto-Linting: Spelling Black Style Checker #2800

Conversation

mrmundt commented Apr 10, 2023

Fixes #329

Summary/Motivation:

Changes proposed in this PR:

Legal Acknowledgement

jsiirola left a comment

Choose a reason for hiding this comment

codecov bot commented Apr 10, 2023

Codecov Report

Robbybp left a comment

Choose a reason for hiding this comment

Robbybp Apr 10, 2023

Choose a reason for hiding this comment

Robbybp Apr 10, 2023

Choose a reason for hiding this comment

Robbybp Apr 10, 2023

Choose a reason for hiding this comment