enums obfuscate __module__

Summary: We lie about the `__module__` to fix a ton of issues: - fragile tests - customer-generated code that uses `__module__` to generate import paths. Reviewed By: yoney Differential Revision: D62528614 fbshipit-source-id: 6d0e502aa983254774f0f58274bafffd6f9000e7
facebook · Sep 12, 2024 · 7ef4555 · 7ef4555
1 parent 78af7e9
commit 7ef4555
Show file tree

Hide file tree

Showing 72 changed files with 149 additions and 4 deletions.
diff --git a/third-party/thrift/src/thrift/compiler/generate/templates/py3/types/enum_py.mustache b/third-party/thrift/src/thrift/compiler/generate/templates/py3/types/enum_py.mustache
@@ -31,6 +31,7 @@ class {{enum:name}}(
     {{enum_value:py_name}} = {{enum_value:value}}
     {{/enum:values}}
 
+    __module__ = _fbthrift__module_name__
     {{! prevent accidental treatment as py-deprecated }}
     __slots__ = ()
 

diff --git a/...party/thrift/src/thrift/compiler/generate/templates/py3/types/union_type_enum_py.mustache b/...party/thrift/src/thrift/compiler/generate/templates/py3/types/union_type_enum_py.mustache
@@ -34,6 +34,7 @@ class __{{struct:name}}Type(
     {{! put EMPTY = 0 arm last to overwrite any other arms}}
     EMPTY = 0
 
+    __module__ = _fbthrift__module_name__
     {{! prevent accidental treatment as py-deprecated }}
     __slots__ = ()
 

diff --git a/...rc/thrift/compiler/generate/templates/py3/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py.mustache b/...rc/thrift/compiler/generate/templates/py3/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py.mustache
@@ -27,6 +27,7 @@ from thrift.python.types import EnumMeta as __EnumMeta
 import thrift.py3.types
 import {{#program:py3Namespaces}}{{value}}.{{/program:py3Namespaces}}{{program:name}}.thrift_metadata
 
+_fbthrift__module_name__ = "{{#program:py3Namespaces}}{{value}}.{{/program:py3Namespaces}}{{program:name}}.types"
 
 {{> types/enum_py }}
 

diff --git a/.../fixtures/basic-annotations/out/py3/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/.../fixtures/basic-annotations/out/py3/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import module.thrift_metadata
 
+_fbthrift__module_name__ = "module.types"
 
 
 
@@ -21,6 +22,7 @@ class MyEnum(
     MyValue2 = 1
     DOMAIN = 2
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod

diff --git a/...um/out/py3/gen-py3/test/fixtures/enumstrict/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...um/out/py3/gen-py3/test/fixtures/enumstrict/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import test.fixtures.enumstrict.module.thrift_metadata
 
+_fbthrift__module_name__ = "test.fixtures.enumstrict.module.types"
 
 
 
@@ -18,6 +19,7 @@ class EmptyEnum(
     metaclass=__EnumMeta,
 ):
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -51,6 +53,7 @@ class MyEnum(
     ONE = 1
     TWO = 2
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -85,6 +88,7 @@ class MyUseIntrinsicDefaultEnum(
     ONE = 1
     TWO = 2
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -136,6 +140,7 @@ class MyBigEnum(
     EIGHTEEN = 18
     NINETEEN = 19
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod

diff --git a/...tures/basic-stack-arguments/out/py3/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...tures/basic-stack-arguments/out/py3/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import module.thrift_metadata
 
+_fbthrift__module_name__ = "module.types"
 
 
 
@@ -20,6 +21,7 @@ class MyEnum(
     MyValue1 = 0
     MyValue2 = 1
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod

diff --git a/...s/basic/out/py3/gen-py3/test/fixtures/basic/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...s/basic/out/py3/gen-py3/test/fixtures/basic/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import test.fixtures.basic.module.thrift_metadata
 
+_fbthrift__module_name__ = "test.fixtures.basic.module.types"
 
 
 
@@ -20,6 +21,7 @@ class MyEnum(
     MyValue1 = 0
     MyValue2 = 1
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -53,6 +55,7 @@ class HackEnum(
     Value1 = 0
     Value2 = 1
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -90,6 +93,7 @@ class __MyUnionType(
     floatSet = 4
     EMPTY = 0
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
 
@@ -100,5 +104,6 @@ class __UnionToBeRenamedType(
     reserved_field = 1
     EMPTY = 0
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
diff --git a/...test/fixtures/complex-union/out/py3/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...test/fixtures/complex-union/out/py3/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import module.thrift_metadata
 
+_fbthrift__module_name__ = "module.types"
 
 
 
@@ -26,6 +27,7 @@ class __ComplexUnionType(
     stringRef = 14
     EMPTY = 0
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
 
@@ -37,6 +39,7 @@ class __ListUnionType(
     stringListValue = 3
     EMPTY = 0
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
 
@@ -48,6 +51,7 @@ class __DataUnionType(
     stringData = 2
     EMPTY = 0
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
 
@@ -59,6 +63,7 @@ class __ValUnionType(
     v2 = 2
     EMPTY = 0
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
 
@@ -70,6 +75,7 @@ class __VirtualComplexUnionType(
     thingTwo = 2
     EMPTY = 0
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
 
@@ -80,5 +86,6 @@ class __NonCopyableUnionType(
     s = 1
     EMPTY = 0
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
diff --git a/...ler/test/fixtures/constants/out/py3/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...ler/test/fixtures/constants/out/py3/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import module.thrift_metadata
 
+_fbthrift__module_name__ = "module.types"
 
 
 
@@ -18,6 +19,7 @@ class EmptyEnum(
     metaclass=__EnumMeta,
 ):
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -53,6 +55,7 @@ class City(
     SEA = 2
     LON = 3
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -88,6 +91,7 @@ class Company(
     OCULUS = 2
     INSTAGRAM = 3
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -123,6 +127,7 @@ class __union1Type(
     d = 2
     EMPTY = 0
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
 
@@ -136,5 +141,6 @@ class __union2Type(
     u = 4
     EMPTY = 0
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
diff --git a/.../test/fixtures/empty-struct/out/py3/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/.../test/fixtures/empty-struct/out/py3/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import module.thrift_metadata
 
+_fbthrift__module_name__ = "module.types"
 
 
 
@@ -20,5 +21,6 @@ class __NadaType(
 ):
     EMPTY = 0
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
diff --git a/...s/enums/out/py3/gen-py3/test/fixtures/enums/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...s/enums/out/py3/gen-py3/test/fixtures/enums/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import test.fixtures.enums.module.thrift_metadata
 
+_fbthrift__module_name__ = "test.fixtures.enums.module.types"
 
 
 
@@ -22,6 +23,7 @@ class Metasyntactic(
     BAZ = 3
     BAX = 4
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -59,6 +61,7 @@ class MyEnum1(
     ME1_5 = 5
     ME1_6 = 6
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -93,6 +96,7 @@ class MyEnum2(
     ME2_1 = 1
     ME2_2 = 2
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -130,6 +134,7 @@ class MyEnum3(
     ME3_9 = 9
     ME3_10 = 10
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -165,6 +170,7 @@ class MyEnum4(
     ME4_C = 2147483647
     ME4_D = -2147483648
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -199,6 +205,7 @@ class MyBitmaskEnum1(
     TWO = 2
     FOUR = 4
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod
@@ -233,6 +240,7 @@ class MyBitmaskEnum2(
     TWO = 2
     FOUR = 4
 
+    __module__ = _fbthrift__module_name__
     __slots__ = ()
 
     @staticmethod

diff --git a/...er/test/fixtures/exceptions/out/py3/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...er/test/fixtures/exceptions/out/py3/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import module.thrift_metadata
 
+_fbthrift__module_name__ = "module.types"
 
 
 
diff --git a/...res/includes/out/py3_auto_migrate/gen-py3/includes/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...res/includes/out/py3_auto_migrate/gen-py3/includes/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import includes.thrift_metadata
 
+_fbthrift__module_name__ = "includes.types"
 
 
 
diff --git a/...tures/includes/out/py3_auto_migrate/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...tures/includes/out/py3_auto_migrate/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import module.thrift_metadata
 
+_fbthrift__module_name__ = "module.types"
 
 
 
diff --git a/...s/includes/out/py3_auto_migrate/gen-py3/transitive/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...s/includes/out/py3_auto_migrate/gen-py3/transitive/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import transitive.thrift_metadata
 
+_fbthrift__module_name__ = "transitive.types"
 
 
 
diff --git a/...des/out/py3_auto_migrate_includes/gen-py3/includes/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...des/out/py3_auto_migrate_includes/gen-py3/includes/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import includes.thrift_metadata
 
+_fbthrift__module_name__ = "includes.types"
 
 
 
diff --git a/...s/out/py3_auto_migrate_includes/gen-py3/transitive/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...s/out/py3_auto_migrate_includes/gen-py3/transitive/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import transitive.thrift_metadata
 
+_fbthrift__module_name__ = "transitive.types"
 
 
 
diff --git a/...udes/out/py3_auto_migrate_service/gen-py3/includes/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...udes/out/py3_auto_migrate_service/gen-py3/includes/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import includes.thrift_metadata
 
+_fbthrift__module_name__ = "includes.types"
 
 
 
diff --git a/...cludes/out/py3_auto_migrate_service/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...cludes/out/py3_auto_migrate_service/gen-py3/module/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import module.thrift_metadata
 
+_fbthrift__module_name__ = "module.types"
 
 
 
diff --git a/...ludes/out/py3_auto_migrate_service/gen-py3/service/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...ludes/out/py3_auto_migrate_service/gen-py3/service/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import service.thrift_metadata
 
+_fbthrift__module_name__ = "service.types"
 
 
 
diff --git a/...es/out/py3_auto_migrate_service/gen-py3/transitive/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py b/...es/out/py3_auto_migrate_service/gen-py3/transitive/types_impl_FBTHRIFT_ONLY_DO_NOT_USE.py
@@ -10,6 +10,7 @@
 import thrift.py3.types
 import transitive.thrift_metadata
 
+_fbthrift__module_name__ = "transitive.types"