Add documentation to methods.

Author: brtieu

src/sasctl/pzmm/write_json_files.py

@@ -958,12 +958,13 @@ def convertDataRole(self, dataRole):
         return conversion
 
     def get_imports(self):
-        """[summary]
+        """
+        Gets the Python modules from the current scope's global variables.  
 
         Yields
         -------
-        [type]
-            [description]
+        str
+            Name of the package that is generated.
         """
 
         for name, val in globals().items():
@@ -976,29 +977,36 @@ def get_imports(self):
                 yield name
 
     def get_pickle_file(self, pPath):
-        """[summary]
+        """
+        Given a file path, retrieve the pickle file(s).
 
         Parameters
         ----------
-        pPath : [type]
-            [description]
+        pPath : str
+            File location for the input pickle file. Default is the current
+            working directory.
         """
+
         fileNames = []
         fileNames.extend(sorted(Path(pPath).glob("*.pickle")))
 
     def get_modules_from_pickle_file(self, pickle_file):
-        """[summary]
+        """
+        Reads the pickled byte stream from a file object, serializes the pickled byte 
+        stream as a bytes object, and inspects the bytes object for all Python modules 
+        and aggregates them in a set.
 
         Parameters
         ----------
-        pickle_file : [type]
-            [description]
+        pickle_file : str
+            The file where you stored pickle data.
 
         Returns
         -------
-        [type]
-            [description]
+        set
+            A set of modules obtained from the pickle stream.
         """
+
         with (open(pickle_file, "rb")) as openfile:
             obj = pickle.load(openfile)
             dumps = pickle.dumps(obj)
@@ -1007,12 +1015,13 @@ def get_modules_from_pickle_file(self, pickle_file):
         return modules
 
     def createRequirementsJSON(self, jPath=Path.cwd()):
-        """[summary]
+        """
+        Searches the root of the project for all Python modules and writes them to a requirements.json file.
 
         Parameters
         ----------
-        jPath : [type], optional
-            [description], by default Path.cwd()
+        jPath : str, optional
+            The path to a Python project, by default Path.cwd().
         """
 
         imports = list(set(self.get_imports()))
@@ -1074,19 +1083,21 @@ def createRequirementsJSON(self, jPath=Path.cwd()):
             print(j, file=file)
 
     def get_names(self, stream):
-        """Generates (module, qualname) tuples from a pickle stream
+        """
+        Generates (module, class_name) tuples from a pickle stream. Extracts all class names referenced by GLOBAL and STACK_GLOBAL opcodes.
 
         Credit: https://stackoverflow.com/questions/64850179/inspecting-a-pickle-dump-for-dependencies
+        More information here: https://github.com/python/cpython/blob/main/Lib/pickletools.py
 
         Parameters
         ----------
-        stream : [type]
-            [description]
+        stream : bytes or str
+            A file like object or string containing the pickle.
 
         Yields
         -------
-        [type]
-            [description]
+        tuple
+            Generated (module, class_name) tuples.
         """
 
         stack, markstack, memo = [], [], []