def store_activity_record(
self, linked_commit: str,
activity_record: ActivityRecord) -> Optional[str]:
"""Method to commit changes to a file
Args:
linked_commit(str): Git commit this ActivityRecord is related to
activity_record(ActivityNote): The populated ActivityNote object returned by the processing pipeline
Returns:
str
"""
activity_record.linked_commit = linked_commit
# Create a activity record
record = self.activity_store.create_activity_record(activity_record)
return record.commit
def remove_packages(self, package_manager: str,
package_names: List[str]) -> None:
"""Remove yaml files describing a package and its context to the labbook.
Args:
package_manager: The package manager (eg., "apt" or "pip3")
package_names: A list of packages to uninstall
Returns:
None
"""
# Create activity record
ar = ActivityRecord(
ActivityType.ENVIRONMENT,
message="",
show=True,
linked_commit="",
tags=["environment", 'package_manager', package_manager])
for pkg in package_names:
yaml_filename = '{}_{}.yaml'.format(package_manager, pkg)
package_yaml_path = os.path.join(self.env_dir, 'package_manager',
yaml_filename)
# Check for package to exist
if not os.path.exists(package_yaml_path):
raise ValueError(
f"{package_manager} installed package {pkg} does not exist."
)
# Check to make sure package isn't from the base. You cannot remove packages from the base yet.
with open(package_yaml_path, 'rt') as cf:
package_data = yaml.safe_load(cf)
if not package_data:
raise IOError("Failed to load package description")
if package_data['from_base'] is True:
raise ValueError(
"Cannot remove a package installed in the Base")
# Delete the yaml file, which on next Dockerfile gen/rebuild will remove the dependency
os.remove(package_yaml_path)
if os.path.exists(package_yaml_path):
raise ValueError(f"Failed to remove package.")
self.labbook.git.remove(package_yaml_path)
# Create detail record
adr = ActivityDetailRecord(ActivityDetailType.ENVIRONMENT,
show=False,
action=ActivityAction.DELETE)
adr.add_value('text/plain',
f"Removed {package_manager} managed package: {pkg}")
ar.add_detail_object(adr)
logger.info(f"Removed {package_manager} managed package: {pkg}")
# Add to git
short_message = f"Removed {len(package_names)} {package_manager} managed package(s)"
commit = self.labbook.git.commit(short_message)
ar.linked_commit = commit.hexsha
ar.message = short_message
# Store
ars = ActivityStore(self.labbook)
ars.create_activity_record(ar)
def add_packages(self,
package_manager: str,
packages: List[dict],
force: bool = False,
from_base: bool = False) -> None:
"""Add a new yaml file describing the new package and its context to the labbook.
Args:
package_manager: The package manager (eg., "apt" or "pip3")
packages: A dictionary of packages to install (package & version are main keys needed)
force: Force overwriting a component if it already exists (e.g. you want to update the version)
from_base: If a package in a base image, not deletable. Otherwise, can be deleted by LB user.
Returns:
None
"""
if not package_manager:
raise ValueError(
'Argument package_manager cannot be None or empty')
# Create activity record
ar = ActivityRecord(
ActivityType.ENVIRONMENT,
show=True,
message="",
linked_commit="",
tags=["environment", 'package_manager', package_manager])
update_cnt = 0
add_cnt = 0
for pkg in packages:
version_str = f'"{pkg["version"]}"' if pkg["version"] else 'latest'
yaml_lines = [
'# Generated on: {}'.format(str(datetime.datetime.now())),
'manager: "{}"'.format(package_manager),
'package: "{}"'.format(pkg["package"]),
'version: {}'.format(version_str),
f'from_base: {str(from_base).lower()}',
f'schema: {CURRENT_SCHEMA}'
]
yaml_filename = '{}_{}.yaml'.format(package_manager,
pkg["package"])
package_yaml_path = os.path.join(self.env_dir, 'package_manager',
yaml_filename)
# Check if package already exists
if os.path.exists(package_yaml_path):
if force:
# You are updating, since force is set and package already exists.
logger.warning("Updating package file at {}".format(
package_yaml_path))
detail_msg = "Update {} managed package: {} {}".format(
package_manager, pkg["package"], version_str)
adr = ActivityDetailRecord(ActivityDetailType.ENVIRONMENT,
show=False,
action=ActivityAction.EDIT)
update_cnt += 1
else:
raise ValueError(
"The package {} already exists in this LabBook.".
format(pkg["package"]) + " Use `force` to overwrite")
else:
add_cnt += 1
detail_msg = "Add {} managed package: {} {}".format(
package_manager, pkg["package"], version_str)
adr = ActivityDetailRecord(ActivityDetailType.ENVIRONMENT,
show=False,
action=ActivityAction.CREATE)
# Write the YAML to the file
with open(package_yaml_path, 'w') as package_yaml_file:
package_yaml_file.write(os.linesep.join(yaml_lines))
# Create activity record
adr.add_value('text/plain', detail_msg)
ar.add_detail_object(adr)
logger.info("Added package {} to labbook at {}".format(
pkg["package"], self.labbook.root_dir))
# Set activity message
ar_msg = ""
if add_cnt > 0:
ar_msg = f"Added {add_cnt} {package_manager} package(s). "
if update_cnt > 0:
ar_msg = f"{ar_msg}Updated {update_cnt} {package_manager} package(s)"
# Add to git
self.labbook.git.add_all(self.env_dir)
commit = self.labbook.git.commit(ar_msg)
ar.linked_commit = commit.hexsha
ar.message = ar_msg
# Store
ars = ActivityStore(self.labbook)
ars.create_activity_record(ar)