include_source as in-source option replacing MODAL_AUTOMOUNT
#2804
Conversation
freider
changed the title
include_source as in-source option replacing MODAL_AUTOMOUNT
| @@ -60,3 +60,6 @@ known-first-party = [ | |||
| "modal_version", | |||
| ] | |||
| extra-standard-library = ["pytest"] | |||
|
|
|||
| [tool.pyright] | |||
| reportUnnecessaryComparison = true | |||
There was a problem hiding this comment.
Found this gem for pyright that is deactivated by default - warns if a comparison would always evaluate to False because you mistyped a literal etc.
| env={**os.environ, "MODAL_AUTOMOUNT": "0"}, | ||
| ) | ||
| assert p.returncode == 0 | ||
| files = set(servicer.files_name2sha.keys()) - set(env_mount_files) | ||
| assert files == { | ||
| "/root/pkg_a/__init__.py", | ||
| "/root/pkg_a/a.py", |
There was a problem hiding this comment.
Change to the automount=0 behavior results in this, as documented by the second changelog bullet
|
I edited the changelog for formatting but have two questions about it:
|
I just removed the change of the entrypoint mount file inclusion filter from this PR, since it feels like a big enough change that it warrants a deprecation warning first. Made a comment and will make a separate PR that adds that warning instead This_package is not a magical incantation, it just served as an example of the package containing the function, I think. Removing |
| @@ -346,7 +341,7 @@ def get_entrypoint_mount(self) -> list[_Mount]: | |||
| remote_path=remote_path, | |||
| ) | |||
| ] | |||
| return [] | |||
| return [] # this should never be reached... | |||
There was a problem hiding this comment.
This is known in the business as "dramatic foreshadowing"
| field = rand.choice(list(oneof.fields) + [None]) | ||
| if field is not None: | ||
| oneof_fields.add(field.name) | ||
| oneof_field: Union[FieldDescriptor, None] = rand.choice(list(oneof.fields) + [None]) |
There was a problem hiding this comment.
I think it was some typing BS that randomly popped up
Introduces an
include_sourceargument inApp.__init__,app.functionandapp.clsthat lets users configure which class of python packages are automatically included as source mounts in created modal functions/classes (what we used to call "automount" behavior).This will supersede the MODAL_AUTOMOUNT configuration value which will eventually be deprecated.
In follow up PR, anyone that is still on "MODAL_AUTOMOUNT=1" behavior (the default), hasn't explicitly set
include_source=True | Falseand seemingly rely on automounting in their code will be warned that implicit automounting is going away soon and they need to use theinclude_sourcein-code configuration option instead to keep the old behavior (or preferably add explicit.add_local_python_source()to their images).Backward/forward compatibility checks
Check these boxes or delete any item (or this section) if not relevant for this PR.
Note on protobuf: protobuf message changes in one place may have impact to
multiple entities (client, server, worker, database). See points above.
Changelog
Introduces an
include_sourceargument in theApp.functionandApp.clsdecorators that let users configure which class of python packages are automatically included as source mounts in created modal functions/classes (what we used to call "automount" behavior). This will supersede the MODAL_AUTOMOUNT configuration value which will eventually be deprecated. As a convenience, themodal.Appconstructor will also accept aninclude_sourceargument which serves as the default for all the app's functions and classes.The
include_sourceargument accepts the following values:True(default in a future version of Modal) Automatically includes the Python files of the source package of the function's own home module, but not any other local packages. Roughly equivalent otMODAL_AUTOMOUNT=0in previous versions of Modal.False- don't include any local source. Assumes the function's home module is importable in the container environment through some other means (typically added to the providedmodal.Image's Python environment).None(the default) - use current soon-to-be-deprecated automounting behavior, including source of all first party packages that are not installed into site-packages locally.Minor change to
MODAL_AUTOMOUNT=0: When running/deploying using a module path (e.g.modal run mypak.mymod), all non .pyc files of the source package (mypakin this case) are now included in the function's container. Previously, only the function's home.pymodule file + any__init__.pyfiles in its package structure were included. Note that this is only for MODAL_AUTOMOUNT=0. To get full control over which source files are included with your functions, you can setinclude_source=Falseon your function (see above) and manually specify the files to include using theignoreargument toImage.add_local_python_source.