cleanup: sort output in generated __init__.py files better (#846)

Author: software-dov

gapic/ads-templates/%namespace/%name/%version/%sub/__init__.py.j2

@@ -8,23 +8,21 @@
     them again.
 -#}
 __all__ = (
-    {% filter sort_lines %}
-    {% for subpackage in api.subpackages.keys() %}
+    {% for subpackage in api.subpackages|dictsort %}
     '{{ subpackage }}',
     {% endfor %}
-    {% for service in api.services.values()
+    {% for service in api.services.values()|sort(attribute='client_name')
             if service.meta.address.subpackage == api.subpackage_view %}
     '{{ service.client_name }}',
     {% endfor %}
-    {% for proto in api.protos.values()
+    {% for proto in api.protos.values()|sort(attribute='name')
             if proto.meta.address.subpackage == api.subpackage_view %}
     {% for message in proto.messages.values() %}
     '{{ message.name }}',
     {% endfor %}
-    {% for enum in proto.enums.values() %}
+    {% for enum in proto.enums.values()|sort(attribute='name') %}
     '{{ enum.name }}',
     {% endfor %}
     {% endfor %}
-    {% endfilter %}
 )
 {% endblock %}

gapic/ads-templates/%namespace/%name/%version/__init__.py.j2

@@ -50,8 +50,7 @@ def __dir__():
     return globals().get('__all__') or __getattr__('__all__')
 {% else %}                {# do not use lazy import #}
 {#  Import subpackages. -#}
-{% filter sort_lines %}
-{% for subpackage in api.subpackages.keys() %}
+{% for subpackage in api.subpackages|dictsort %}
 from {% if api.naming.module_namespace %}{{ api.naming.module_namespace|join('.') }}.{% endif %}
     {{ api.naming.versioned_module_name }} import {{ subpackage }}
 {% endfor %}
@@ -83,15 +82,13 @@ from {% if api.naming.module_namespace %}{{ api.naming.module_namespace|join('.'
 from {% if api.naming.module_namespace %}{{ api.naming.module_namespace|join('.') }}.{% endif %}
     {{ api.naming.versioned_module_name }}.types.{{ proto.module_name }} import {{ enum.name }}
 {% endfor %}{% endfor %}
-{% endfilter %}
 {#  Define __all__.
     This requires the full set of imported names, so we iterate over
     them again.
 -#}
 __all__ = (
 {% filter indent %}
-{% filter sort_lines %}
-{% for subpackage in api.subpackages.keys() %}
+{% for subpackage in api.subpackages|dictsort %}
 '{{ subpackage }}',
 {% endfor %}
 {% for service in api.services.values()|sort(attribute='name')
@@ -108,7 +105,6 @@ __all__ = (
 '{{ enum.name }}',
 {% endfor %}{% endfor %}
 {% endfilter %}
-{% endfilter %}
 )
 {% endif %} {# lazy import #}
 {% endblock %}

gapic/ads-templates/%namespace/%name/__init__.py.j2

@@ -48,8 +48,7 @@ def __dir__():
     return globals().get('__all__') or __getattr__('__all__')
 {% else %}                {# do not use lazy import #}
 {#  Import subpackages. -#}
-{% filter sort_lines %}
-{% for subpackage in api.subpackages.keys() %}
+{% for subpackage in api.subpackages|dictsort %}
 from {% if api.naming.module_namespace %}{{ api.naming.module_namespace|join('.') }}.{% endif %}
     {{- api.naming.versioned_module_name }} import {{ subpackage }}
 {% endfor %}
@@ -81,14 +80,12 @@ from {% if api.naming.module_namespace %}{{ api.naming.module_namespace|join('.'
 from {% if api.naming.module_namespace %}{{ api.naming.module_namespace|join('.') }}.{% endif %}
     {{- api.naming.versioned_module_name }}.types.{{ proto.module_name }} import {{ enum.name }}
 {% endfor %}{% endfor %}
-{% endfilter %}
 {#  Define __all__.
     This requires the full set of imported names, so we iterate over
     them again.
 #}
 __all__ = (
 {% filter indent %}
-{% filter sort_lines %}
 {% for subpackage, _ in api.subpackages|dictsort %}
 '{{ subpackage }}',
 {% endfor %}
@@ -106,7 +103,6 @@ __all__ = (
 '{{ enum.name }}',
 {% endfor %}{% endfor %}
 {% endfilter %}
-{% endfilter %}
 )
 {% endif %} {# lazy import #}
 {% endblock %}

gapic/schema/metadata.py

@@ -50,8 +50,8 @@ class Address:
     collisions: FrozenSet[str] = dataclasses.field(default_factory=frozenset)
 
     def __eq__(self, other) -> bool:
-        return all([getattr(self, i) == getattr(other, i) for i
-                    in ('name', 'module', 'module_path', 'package', 'parent')])
+        return all(getattr(self, i) == getattr(other, i)
+                   for i in ('name', 'module', 'module_path', 'package', 'parent'))
 
     def __hash__(self):
         # Do NOT include collisions; they are not relevant.
@@ -188,7 +188,7 @@ def sphinx(self) -> str:
         if self.proto_package.startswith(self.api_naming.proto_package):
             return '.'.join(self.api_naming.module_namespace + (
                 self.api_naming.versioned_module_name,
-                ) + self.subpackage + ('types',) + self.parent + (self.name, ))
+            ) + self.subpackage + ('types',) + self.parent + (self.name, ))
 
         # Anything left is a standard _pb2 type
         return f'{self.proto_package}.{self.module}_pb2.{self.name}'

gapic/templates/%namespace/%name/__init__.py.j2

@@ -2,8 +2,7 @@
 {% block content %}
 
 {#  Import subpackages. -#}
-{% filter sort_lines %}
-{% for subpackage in api.subpackages.keys() %}
+{% for subpackage in api.subpackages|dictsort %}
 from {% if api.naming.module_namespace %}{{ api.naming.module_namespace|join('.') }}.{% endif %}
     {{- api.naming.versioned_module_name }} import {{ subpackage }}
 {% endfor %}
@@ -39,15 +38,13 @@ from {% if api.naming.module_namespace %}{{ api.naming.module_namespace|join('.'
 from {% if api.naming.module_namespace %}{{ api.naming.module_namespace|join('.') }}.{% endif %}
     {{- api.naming.versioned_module_name }}.types.{{ proto.module_name }} import {{ enum.name }}
 {% endfor %}{% endfor %}
-{% endfilter %}
 {#  Define __all__.
     This requires the full set of imported names, so we iterate over
     them again.
 #}
 
 __all__ = (
 {%- filter indent %}
-{% filter sort_lines %}
 {% for subpackage, _ in api.subpackages|dictsort %}
 '{{ subpackage }}',
 {% endfor %}
@@ -68,6 +65,5 @@ __all__ = (
 '{{ enum.name }}',
 {% endfor %}{% endfor %}
 {% endfilter %}
-{% endfilter %}
 )
 {% endblock %}

gapic/templates/%namespace/%name_%version/%sub/__init__.py.j2

@@ -8,52 +8,46 @@ from . import {{ subpackage }}
 {% endfor %}
 
 {#  Import services for this package. -#}
-{% filter sort_lines %}
 {% for service in api.services.values()|sort(attribute='name')
         if service.meta.address.subpackage == api.subpackage_view %}
 from .services.{{ service.name|snake_case }} import {{ service.client_name }}
 {% endfor %}
-{% endfilter %}
 
 {#  Import messages and enums from each proto.
     It is safe to import all of the messages into the same namespace here,
     because protocol buffers itself enforces selector uniqueness within
     a proto package.
 -#}
-{% filter sort_lines %}
-{% for proto in api.protos.values()
+{% for proto in api.protos.values()|sort(attribute='name')
         if proto.meta.address.subpackage == api.subpackage_view %}
-{% for message in proto.messages.values() %}
+{% for message in proto.messages.values()|sort(attribute='name') %}
 from .types.{{ proto.module_name }} import {{ message.name }}
 {% endfor %}
-{% for enum in proto.enums.values() %}
+{% for enum in proto.enums.values()|sort(attribute='name') %}
 from .types.{{ proto.module_name }} import {{ enum.name }}
 {% endfor %}
 {% endfor %}
-{% endfilter %}
 
 {#  Define __all__.
     This requires the full set of imported names, so we iterate over
     them again.
 -#}
 __all__ = (
-    {% filter sort_lines %}
-    {% for subpackage in api.subpackages.keys() %}
+    {% for subpackage in api.subpackages|dictsort %}
     '{{ subpackage }}',
     {% endfor %}
-    {% for service in api.services.values()
+    {% for service in api.services.values()|sort(attribute='client_name')
             if service.meta.address.subpackage == api.subpackage_view %}
     '{{ service.client_name }}',
     {% endfor %}
-    {% for proto in api.protos.values()
+    {% for proto in api.protos.values()|sort(attribute='name')
             if proto.meta.address.subpackage == api.subpackage_view %}
-    {% for message in proto.messages.values() %}
+    {% for message in proto.messages.values()|sort(attribute='name') %}
     '{{ message.name }}',
     {% endfor %}
-    {% for enum in proto.enums.values() %}
+    {% for enum in proto.enums.values()|sort(attribute='name') %}
     '{{ enum.name }}',
     {% endfor %}
     {% endfor %}
-    {% endfilter %}
 )
 {% endblock %}