Skip to content
This repository has been archived by the owner on Oct 10, 2020. It is now read-only.

Documenting some functions and methods that are difficult to understand. #1225

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions Atomic/atomic.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,12 @@
from docker.errors import NotFound
from .discovery import RegistryInspect, RegistryInspectError


Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd remove at least one if not two of these added blank lines.

def find_repo_tag(d, Id, image_name):

# The image_in_repotags function fetches the name of the image inside the "repotag" repository, and if found,
# returns the name of the image, or image list.

def image_in_repotags(image_name, repotags):
if image_name in repotags:
return image_name
Expand Down Expand Up @@ -118,6 +123,11 @@ def pull(self):
prevstatus = status
util.write_out("")

# If for some reason the NameError or AttributeError class appears in the path,
# the exception is thrown to ignore the "pass" problem.
# The NameError class handles only unqualified names while AtributeError,
# appears when an object does not support attribute references or assignments.

def set_args(self, args):
self.args = args
try:
Expand Down Expand Up @@ -218,6 +228,10 @@ def _get_args(self, label):
def quote(self, args):
return list(map(pipes.quote, args))

# This function cmd_env adds the atomic project environment variables within a dictionary (key and value),
# and reassigns some of its values as image and image name.
# The goal here is to return the argument, with expanded environment variables and return new newenv.

def cmd_env(self):
newenv = dict(os.environ)
newenv['NAME'] = self.name or ""
Expand Down