Changeset 274f9ef in flex_extract.git for source/python/classes/ControlFile.py

Timestamp:

Oct 22, 2018, 11:44:47 AM (5 years ago)

Author:

Anne Philipp <anne.philipp@…>

Branches:

master, ctbto, dev

Children:

db27c09

Parents:

708c667

Message:

Converted docstrings to numpy style and build first structure for sphinxdocumentation (incl API)

File:

• source/python/classes/ControlFile.py (modified) (8 diffs)

source/python/classes/ControlFile.py

@@ -71 +71 @@
 
     def __init__(self, filename):
-        '''
-        @Description:
-            Initialises the instance of ControlFile class and defines
-            all class attributes with default values. Afterwards calls
-            function __read_controlfile__ to read parameter from
-            Control file.
-
-        @Input:
-            self: instance of ControlFile class
-                Description see class documentation.
-
-            filename: string
-                Name of CONTROL file.
-
-        @Return:
-            <nothing>
+        '''Initialises the instance of ControlFile class and defines
+        all class attributes with default values. Afterwards calls
+        function __read_controlfile__ to read parameter from Control file.
+
+        Parameters
+        ----------
+        filename : :obj:`string`
+            Name of CONTROL file.
+
+        Return
+        ------
+
         '''
 
@@ -162 +158 @@
 
     def __read_controlfile__(self):
-        '''
-        @Description:
-            Read CONTROL file and assign all CONTROL file variables.
-
-        @Input:
-            self: instance of ControlFile class
-                Description see class documentation.
-
-        @Return:
-            <nothing>
+        '''Read CONTROL file and assign all CONTROL file variables.
+
+        Parameters
+        ----------
+
+        Return
+        ------
+
         '''
 
@@ -235 +229 @@
 
     def __str__(self):
-        '''
-        @Description:
-            Prepares a string which have all the ControlFile
-            class attributes with its associated values.
-            Each attribute is printed in one line and in
-            alphabetical order.
-
-            Example:
-            'age': 10
-            'color': 'Spotted'
-            'kids': 0
-            'legs': 2
-            'name': 'Dog'
-            'smell': 'Alot'
-
-        @Input:
-            self: instance of ControlFile class
-                Description see class documentation.
-
-        @Return:
-            string of ControlFile class attributes with their values
+        '''Prepares a string which have all the ControlFile class attributes
+        with its associated values. Each attribute is printed in one line and
+        in alphabetical order.
+
+        Example
+        -------
+        'age': 10
+        'color': 'Spotted'
+        'kids': 0
+        'legs': 2
+        'name': 'Dog'
+        'smell': 'Alot'
+
+        Parameters
+        ----------
+
+        Return
+        ------
+        string
+            Single string of concatenated ControlFile class attributes
+            with their values
         '''
         import collections
@@ -265 +259 @@
 
     def assign_args_to_control(self, args):
-        '''
-        @Description:
-            Overwrites the existing ControlFile instance attributes with
-            the command line arguments.
-
-        @Input:
-            self: instance of ControlFile class
-                Description see class documentation.
-
-            args: instance of ArgumentParser
-                Contains the commandline arguments from script/program call.
-
-        @Return:
-            <nothing>
+        '''Overwrites the existing ControlFile instance attributes with
+        the command line arguments.
+
+        Parameters
+        ----------
+        args : :obj:`Namespace`
+            Contains the commandline arguments from script/program call.
+
+        Return
+        ------
+
         '''
 
@@ -294 +285 @@
 
     def assign_envs_to_control(self, envs):
-        '''
-        @Description:
-            Assigns the ECMWF environment parameter.
-
-        @Input:
-            envs: dict of strings
-                Contains the ECMWF environment parameternames "ECUID", "ECGID",
-                "DESTINATION" and "GATEWAY" with its corresponding values.
-                They were read from the file "ECMWF_ENV".
-
-        @Return:
-            <nothing>
+        '''Assigns the ECMWF environment parameter.
+
+        Parameters
+        ----------
+        envs : :obj:`dictionary` of :obj:`strings`
+            Contains the ECMWF environment parameternames "ECUID", "ECGID",
+            "DESTINATION" and "GATEWAY" with its corresponding values.
+            They were read from the file "ECMWF_ENV".
+
+        Return
+        ------
+
         '''
 
@@ -314 +305 @@
 
     def check_conditions(self, queue):
-        '''
-        @Description:
-            Checks a couple of necessary attributes and conditions,
-            such as if they exist and contain values.
-            Otherwise set default values.
-
-        @Input:
-            self: instance of ControlFile class
-                Description see class documentation.
-
-            queue: string
-                Name of the queue if submitted to the ECMWF servers.
-                Used to check if ecuid, ecgid, gateway and destination
-                are set correctly and are not empty.
-
-        @Return:
-            <nothing>
+        '''Checks a couple of necessary attributes and conditions,
+        such as if they exist and contain values.
+        Otherwise set default values.
+
+        Parameters
+        ----------
+        queue : :obj:`string`
+            Name of the queue if submitted to the ECMWF servers.
+            Used to check if ecuid, ecgid, gateway and destination
+            are set correctly and are not empty.
+
+        Return
+        ------
+
         '''
         from mods.tools import my_error
@@ -501 +489 @@
 
     def check_install_conditions(self):
-        '''
-        @Description:
-            Checks a couple of necessary attributes and conditions
-            for the installation such as if they exist and contain values.
-            Otherwise set default values.
-
-        @Input:
-            self: instance of ControlFile class
-                Description see class documentation.
-
-        @Return:
-            <nothing>
+        '''Checks a couple of necessary attributes and conditions
+        for the installation such as if they exist and contain values.
+        Otherwise set default values.
+
+        Parameters
+        ----------
+
+        Return
+        ------
+
         '''
 
@@ -549 +535 @@
 
     def to_list(self):
-        '''
-        @Description:
-            Just generates a list of strings containing the attributes and
-            assigned values except the attributes "_expanded", "exedir",
+        '''Just generates a list of strings containing the attributes and
+        assigned values except the attributes "_expanded", "exedir",
+        "ecmwfdatadir" and "flexpart_root_scripts".
+
+        Parameters
+        ----------
+
+        Return
+        ------
+        l : :obj:`list`
+            A sorted list of the all ControlFile class attributes with
+            their values except the attributes "_expanded", "exedir",
             "ecmwfdatadir" and "flexpart_root_scripts".
-
-        @Input:
-            self: instance of ControlFile class
-                Description see class documentation.
-
-        @Return:
-            l: list
-                A sorted list of the all ControlFile class attributes with
-                their values except the attributes "_expanded", "exedir",
-                "ecmwfdatadir" and "flexpart_root_scripts".
         '''