Source code for forml.provider.registry.filesystem.volatile
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""
Volatile registry is a dummy registry implementation that doesn't persist anything outside
the current runtime.
"""
import collections
import logging
import tempfile
import typing
from forml.io import asset
from . import posix
if typing.TYPE_CHECKING:
from forml import project as prj
LOGGER = logging.getLogger(__name__)
[docs]class Registry(posix.Registry, alias='volatile'):
"""(Pseudo)registry implementation provided as temporal non-distributed storage persistent
only during its lifetime.
All content is stored using a local temporal directory auto-purged upon garbage collection.
This registry is internally used by the :class:`Virtual launcher <forml.runtime.Virtual>`.
Defining it explicitly using the :ref:`platform configuration <platform-config>` for other
runtime mechanisms is usually pointless (not invalid though).
"""
def __init__(self):
self._storage: tempfile.TemporaryDirectory = tempfile.TemporaryDirectory( # pylint: disable=consider-using-with
prefix='registry-volatile-', dir=asset.TMPDIR
)
self._artifacts: dict['asset.Project.Key', dict['asset.Release.Key', 'prj.Artifact']] = collections.defaultdict(
dict
)
super().__init__(self._storage.name)
def projects(self) -> typing.Iterable['asset.Project.Key']:
return iter(self._artifacts.keys())
def releases(self, project: 'asset.Project.Key') -> typing.Iterable['asset.Release.Key']:
return iter(self._artifacts[project].keys())
def mount(self, project: 'asset.Project.Key', release: 'asset.Release.Key') -> 'prj.Artifact':
return self._artifacts[project][release]
def pull(self, project: 'asset.Project.Key', release: 'asset.Release.Key') -> 'prj.Package':
raise NotImplementedError('No packages in volatile repository')
def push(self, package: 'prj.Package') -> None:
artifact = package.install(package.path) # avoid copying by installing to self
self._artifacts[package.manifest.name][package.manifest.version] = artifact