mirror of
https://github.com/zebrajr/pytorch.git
synced 2025-12-06 12:20:52 +01:00
8d4e6c9570
Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/56238 It's already functionally public due to `extern` and `mock`, but exposing the underlying implementation makes extending PackageExporter easier. Changed the underscores, expose on `torch.package`, add docs, etc. Differential Revision: D27817013 Test Plan: Imported from OSS Reviewed By: Lilyjjo Pulled By: suo fbshipit-source-id: e39199e7cb5242a8bfb815777e4bb82462864027
224 lines
7.6 KiB
Python
224 lines
7.6 KiB
Python
from io import BytesIO
|
|
from sys import version_info
|
|
from textwrap import dedent
|
|
from unittest import skipIf
|
|
|
|
from torch.package import (
|
|
DeniedModuleError,
|
|
EmptyMatchError,
|
|
PackageExporter,
|
|
PackageImporter,
|
|
)
|
|
from torch.testing._internal.common_utils import run_tests
|
|
|
|
try:
|
|
from .common import PackageTestCase
|
|
except ImportError:
|
|
# Support the case where we run this file directly.
|
|
from common import PackageTestCase # type: ignore
|
|
|
|
|
|
class TestDependencyAPI(PackageTestCase):
|
|
"""Dependency management API tests.
|
|
- mock()
|
|
- extern()
|
|
- deny()
|
|
"""
|
|
|
|
def test_extern(self):
|
|
buffer = BytesIO()
|
|
with PackageExporter(buffer, verbose=False) as he:
|
|
he.extern(["package_a.subpackage", "module_a"])
|
|
he.require_module("package_a.subpackage")
|
|
he.require_module("module_a")
|
|
he.save_module("package_a")
|
|
buffer.seek(0)
|
|
hi = PackageImporter(buffer)
|
|
import module_a
|
|
import package_a.subpackage
|
|
|
|
module_a_im = hi.import_module("module_a")
|
|
hi.import_module("package_a.subpackage")
|
|
package_a_im = hi.import_module("package_a")
|
|
|
|
self.assertIs(module_a, module_a_im)
|
|
self.assertIsNot(package_a, package_a_im)
|
|
self.assertIs(package_a.subpackage, package_a_im.subpackage)
|
|
|
|
def test_extern_glob(self):
|
|
buffer = BytesIO()
|
|
with PackageExporter(buffer, verbose=False) as he:
|
|
he.extern(["package_a.*", "module_*"])
|
|
he.save_module("package_a")
|
|
he.save_source_string(
|
|
"test_module",
|
|
dedent(
|
|
"""\
|
|
import package_a.subpackage
|
|
import module_a
|
|
"""
|
|
),
|
|
)
|
|
buffer.seek(0)
|
|
hi = PackageImporter(buffer)
|
|
import module_a
|
|
import package_a.subpackage
|
|
|
|
module_a_im = hi.import_module("module_a")
|
|
hi.import_module("package_a.subpackage")
|
|
package_a_im = hi.import_module("package_a")
|
|
|
|
self.assertIs(module_a, module_a_im)
|
|
self.assertIsNot(package_a, package_a_im)
|
|
self.assertIs(package_a.subpackage, package_a_im.subpackage)
|
|
|
|
def test_extern_glob_allow_empty(self):
|
|
"""
|
|
Test that an error is thrown when a extern glob is specified with allow_empty=True
|
|
and no matching module is required during packaging.
|
|
"""
|
|
import package_a.subpackage # noqa: F401
|
|
|
|
buffer = BytesIO()
|
|
with self.assertRaisesRegex(EmptyMatchError, r"did not match any modules"):
|
|
with PackageExporter(buffer, verbose=False) as exporter:
|
|
exporter.extern(include=["package_b.*"], allow_empty=False)
|
|
exporter.save_module("package_a.subpackage")
|
|
|
|
def test_deny(self):
|
|
"""
|
|
Test marking packages as "deny" during export.
|
|
"""
|
|
buffer = BytesIO()
|
|
|
|
with self.assertRaisesRegex(
|
|
DeniedModuleError,
|
|
"required during packaging but has been explicitly blocklisted",
|
|
):
|
|
with PackageExporter(buffer, verbose=False) as exporter:
|
|
exporter.deny(["package_a.subpackage", "module_a"])
|
|
exporter.require_module("package_a.subpackage")
|
|
|
|
def test_deny_glob(self):
|
|
"""
|
|
Test marking packages as "deny" using globs instead of package names.
|
|
"""
|
|
buffer = BytesIO()
|
|
with self.assertRaisesRegex(
|
|
DeniedModuleError,
|
|
"required during packaging but has been explicitly blocklisted",
|
|
):
|
|
with PackageExporter(buffer, verbose=False) as exporter:
|
|
exporter.deny(["package_a.*", "module_*"])
|
|
exporter.save_source_string(
|
|
"test_module",
|
|
dedent(
|
|
"""\
|
|
import package_a.subpackage
|
|
import module_a
|
|
"""
|
|
),
|
|
)
|
|
|
|
@skipIf(version_info < (3, 7), "mock uses __getattr__ a 3.7 feature")
|
|
def test_mock(self):
|
|
buffer = BytesIO()
|
|
with PackageExporter(buffer, verbose=False) as he:
|
|
he.mock(["package_a.subpackage", "module_a"])
|
|
he.save_module("package_a")
|
|
he.require_module("package_a.subpackage")
|
|
he.require_module("module_a")
|
|
buffer.seek(0)
|
|
hi = PackageImporter(buffer)
|
|
import package_a.subpackage
|
|
|
|
_ = package_a.subpackage
|
|
import module_a
|
|
|
|
_ = module_a
|
|
|
|
m = hi.import_module("package_a.subpackage")
|
|
r = m.result
|
|
with self.assertRaisesRegex(NotImplementedError, "was mocked out"):
|
|
r()
|
|
|
|
@skipIf(version_info < (3, 7), "mock uses __getattr__ a 3.7 feature")
|
|
def test_mock_glob(self):
|
|
buffer = BytesIO()
|
|
with PackageExporter(buffer, verbose=False) as he:
|
|
he.mock(["package_a.*", "module*"])
|
|
he.save_module("package_a")
|
|
he.save_source_string(
|
|
"test_module",
|
|
dedent(
|
|
"""\
|
|
import package_a.subpackage
|
|
import module_a
|
|
"""
|
|
),
|
|
)
|
|
buffer.seek(0)
|
|
hi = PackageImporter(buffer)
|
|
import package_a.subpackage
|
|
|
|
_ = package_a.subpackage
|
|
import module_a
|
|
|
|
_ = module_a
|
|
|
|
m = hi.import_module("package_a.subpackage")
|
|
r = m.result
|
|
with self.assertRaisesRegex(NotImplementedError, "was mocked out"):
|
|
r()
|
|
|
|
def test_mock_glob_allow_empty(self):
|
|
"""
|
|
Test that an error is thrown when a mock glob is specified with allow_empty=True
|
|
and no matching module is required during packaging.
|
|
"""
|
|
import package_a.subpackage # noqa: F401
|
|
|
|
buffer = BytesIO()
|
|
with self.assertRaisesRegex(EmptyMatchError, r"did not match any modules"):
|
|
with PackageExporter(buffer, verbose=False) as exporter:
|
|
exporter.mock(include=["package_b.*"], allow_empty=False)
|
|
exporter.save_module("package_a.subpackage")
|
|
|
|
@skipIf(version_info < (3, 7), "mock uses __getattr__ a 3.7 feature")
|
|
def test_pickle_mocked(self):
|
|
import package_a.subpackage
|
|
|
|
obj = package_a.subpackage.PackageASubpackageObject()
|
|
obj2 = package_a.PackageAObject(obj)
|
|
|
|
buffer = BytesIO()
|
|
with PackageExporter(buffer, verbose=False) as he:
|
|
he.mock(include="package_a.subpackage")
|
|
he.save_pickle("obj", "obj.pkl", obj2)
|
|
|
|
buffer.seek(0)
|
|
|
|
hi = PackageImporter(buffer)
|
|
with self.assertRaises(NotImplementedError):
|
|
hi.load_pickle("obj", "obj.pkl")
|
|
|
|
def test_allow_empty_with_error(self):
|
|
"""If an error occurs during packaging, it should not be shadowed by the allow_empty error."""
|
|
buffer = BytesIO()
|
|
with self.assertRaises(ModuleNotFoundError):
|
|
with PackageExporter(buffer, verbose=False) as pe:
|
|
# Even though we did not extern a module that matches this
|
|
# pattern, we want to show the save_module error, not the allow_empty error.
|
|
|
|
pe.extern("foo", allow_empty=False)
|
|
pe.save_module("aodoifjodisfj") # will error
|
|
|
|
# we never get here, so technically the allow_empty check
|
|
# should raise an error. However, the error above is more
|
|
# informative to what's actually going wrong with packaging.
|
|
pe.save_source_string("bar", "import foo\n")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
run_tests()
|