[PATCH v2] scripts/qapi: minor delinting

John Snow posted 1 patch 3 years, 12 months ago
Test checkpatch passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20220211183650.2946895-1-jsnow@redhat.com
Maintainers: Michael Roth <michael.roth@amd.com>, Markus Armbruster <armbru@redhat.com>
scripts/qapi/commands.py |  2 +-
scripts/qapi/pylintrc    | 15 +++++----------
scripts/qapi/types.py    |  6 +++++-
scripts/qapi/visit.py    |  6 +++++-
4 files changed, 16 insertions(+), 13 deletions(-)
[PATCH v2] scripts/qapi: minor delinting
Posted by John Snow 3 years, 12 months ago
Get isort and pylint tools passing again.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 scripts/qapi/commands.py |  2 +-
 scripts/qapi/pylintrc    | 15 +++++----------
 scripts/qapi/types.py    |  6 +++++-
 scripts/qapi/visit.py    |  6 +++++-
 4 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/scripts/qapi/commands.py b/scripts/qapi/commands.py
index 869d799ed22..38ca38a7b9d 100644
--- a/scripts/qapi/commands.py
+++ b/scripts/qapi/commands.py
@@ -25,8 +25,8 @@
     QAPIGenC,
     QAPISchemaModularCVisitor,
     build_params,
-    ifcontext,
     gen_special_features,
+    ifcontext,
 )
 from .schema import (
     QAPISchema,
diff --git a/scripts/qapi/pylintrc b/scripts/qapi/pylintrc
index b259531a726..1fed2e69620 100644
--- a/scripts/qapi/pylintrc
+++ b/scripts/qapi/pylintrc
@@ -34,16 +34,11 @@ disable=fixme,
 
 [BASIC]
 
-# Good variable names which should always be accepted, separated by a comma.
-good-names=i,
-           j,
-           k,
-           ex,
-           Run,
-           _,
-           fp,  # fp = open(...)
-           fd,  # fd = os.open(...)
-           ch,
+# Good variable names regexes, separated by a comma. If names match any regex,
+# they will always be accepted
+
+# Allow just about anything, as per Markus's preference.
+good-names-rgxs=^[_a-z][_a-z0-9]?$
 
 [VARIABLES]
 
diff --git a/scripts/qapi/types.py b/scripts/qapi/types.py
index 3013329c248..477d0270013 100644
--- a/scripts/qapi/types.py
+++ b/scripts/qapi/types.py
@@ -16,7 +16,11 @@
 from typing import List, Optional
 
 from .common import c_enum_const, c_name, mcgen
-from .gen import QAPISchemaModularCVisitor, gen_special_features, ifcontext
+from .gen import (
+    QAPISchemaModularCVisitor,
+    gen_special_features,
+    ifcontext,
+)
 from .schema import (
     QAPISchema,
     QAPISchemaEnumMember,
diff --git a/scripts/qapi/visit.py b/scripts/qapi/visit.py
index e13bbe42925..380fa197f58 100644
--- a/scripts/qapi/visit.py
+++ b/scripts/qapi/visit.py
@@ -21,7 +21,11 @@
     indent,
     mcgen,
 )
-from .gen import QAPISchemaModularCVisitor, gen_special_features, ifcontext
+from .gen import (
+    QAPISchemaModularCVisitor,
+    gen_special_features,
+    ifcontext,
+)
 from .schema import (
     QAPISchema,
     QAPISchemaEnumMember,
-- 
2.34.1


Re: [PATCH v2] scripts/qapi: minor delinting
Posted by Markus Armbruster 3 years, 11 months ago
John Snow <jsnow@redhat.com> writes:

> Get isort and pylint tools passing again.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  scripts/qapi/commands.py |  2 +-
>  scripts/qapi/pylintrc    | 15 +++++----------
>  scripts/qapi/types.py    |  6 +++++-
>  scripts/qapi/visit.py    |  6 +++++-
>  4 files changed, 16 insertions(+), 13 deletions(-)
>
> diff --git a/scripts/qapi/commands.py b/scripts/qapi/commands.py
> index 869d799ed22..38ca38a7b9d 100644
> --- a/scripts/qapi/commands.py
> +++ b/scripts/qapi/commands.py
> @@ -25,8 +25,8 @@
>      QAPIGenC,
>      QAPISchemaModularCVisitor,
>      build_params,
> -    ifcontext,
>      gen_special_features,
> +    ifcontext,
>  )
>  from .schema import (
>      QAPISchema,
> diff --git a/scripts/qapi/pylintrc b/scripts/qapi/pylintrc
> index b259531a726..1fed2e69620 100644
> --- a/scripts/qapi/pylintrc
> +++ b/scripts/qapi/pylintrc
> @@ -34,16 +34,11 @@ disable=fixme,
>  
>  [BASIC]
>  
> -# Good variable names which should always be accepted, separated by a comma.
> -good-names=i,
> -           j,
> -           k,
> -           ex,
> -           Run,
> -           _,
> -           fp,  # fp = open(...)
> -           fd,  # fd = os.open(...)
> -           ch,
> +# Good variable names regexes, separated by a comma. If names match any regex,
> +# they will always be accepted
> +
> +# Allow just about anything, as per Markus's preference.

Does it still flag PEP-8 violations like all lower case class names?

If yes, "just about any length" is more precise.

> +good-names-rgxs=^[_a-z][_a-z0-9]?$
>  
>  [VARIABLES]
>  
> diff --git a/scripts/qapi/types.py b/scripts/qapi/types.py
> index 3013329c248..477d0270013 100644
> --- a/scripts/qapi/types.py
> +++ b/scripts/qapi/types.py
> @@ -16,7 +16,11 @@
>  from typing import List, Optional
>  
>  from .common import c_enum_const, c_name, mcgen
> -from .gen import QAPISchemaModularCVisitor, gen_special_features, ifcontext
> +from .gen import (
> +    QAPISchemaModularCVisitor,
> +    gen_special_features,
> +    ifcontext,
> +)
>  from .schema import (
>      QAPISchema,
>      QAPISchemaEnumMember,
> diff --git a/scripts/qapi/visit.py b/scripts/qapi/visit.py
> index e13bbe42925..380fa197f58 100644
> --- a/scripts/qapi/visit.py
> +++ b/scripts/qapi/visit.py
> @@ -21,7 +21,11 @@
>      indent,
>      mcgen,
>  )
> -from .gen import QAPISchemaModularCVisitor, gen_special_features, ifcontext
> +from .gen import (
> +    QAPISchemaModularCVisitor,
> +    gen_special_features,
> +    ifcontext,
> +)
>  from .schema import (
>      QAPISchema,
>      QAPISchemaEnumMember,


Re: [PATCH v2] scripts/qapi: minor delinting
Posted by Markus Armbruster 3 years, 11 months ago
Markus Armbruster <armbru@redhat.com> writes:

> John Snow <jsnow@redhat.com> writes:
>
>> Get isort and pylint tools passing again.
>>
>> Signed-off-by: John Snow <jsnow@redhat.com>
>> ---
>>  scripts/qapi/commands.py |  2 +-
>>  scripts/qapi/pylintrc    | 15 +++++----------
>>  scripts/qapi/types.py    |  6 +++++-
>>  scripts/qapi/visit.py    |  6 +++++-
>>  4 files changed, 16 insertions(+), 13 deletions(-)
>>
>> diff --git a/scripts/qapi/commands.py b/scripts/qapi/commands.py
>> index 869d799ed22..38ca38a7b9d 100644
>> --- a/scripts/qapi/commands.py
>> +++ b/scripts/qapi/commands.py
>> @@ -25,8 +25,8 @@
>>      QAPIGenC,
>>      QAPISchemaModularCVisitor,
>>      build_params,
>> -    ifcontext,
>>      gen_special_features,
>> +    ifcontext,
>>  )
>>  from .schema import (
>>      QAPISchema,
>> diff --git a/scripts/qapi/pylintrc b/scripts/qapi/pylintrc
>> index b259531a726..1fed2e69620 100644
>> --- a/scripts/qapi/pylintrc
>> +++ b/scripts/qapi/pylintrc
>> @@ -34,16 +34,11 @@ disable=fixme,
>>  
>>  [BASIC]
>>  
>> -# Good variable names which should always be accepted, separated by a comma.
>> -good-names=i,
>> -           j,
>> -           k,
>> -           ex,
>> -           Run,
>> -           _,
>> -           fp,  # fp = open(...)
>> -           fd,  # fd = os.open(...)
>> -           ch,
>> +# Good variable names regexes, separated by a comma. If names match any regex,
>> +# they will always be accepted
>> +
>> +# Allow just about anything, as per Markus's preference.
>
> Does it still flag PEP-8 violations like all lower case class names?

Looks like it in my tests.

> If yes, "just about any length" is more precise.

I'll change the comment if you don't mind:

    # Suppress complaints about short names.  PEP-8 is cool with them,
    # and so are we.

With that:
Reviewed-by: Markus Armbruster <armbru@redhat.com>

No respin necessary.


Re: [PATCH v2] scripts/qapi: minor delinting
Posted by Markus Armbruster 3 years, 11 months ago
Queued, thanks!