You are reading the documentation for version 3.0 of ProMod3.
You may also want to read the documentation for:
1.3
2.0
2.1
3.1
3.2
|
Parameters: | |
---|---|
Returns: | No return value, exits script with value |
promod3.core.helper.
FileExtension
(prefix, exit_status, filename, extensions, gzip=False)¶Checks a file to carry a known extension given by a list of strings. Since files are very often compressed these days, an additional “gz” suffix can be tracked automatically by this function. Thus, the list of extensions only needs to contain what you are really looking for, e.g. (“pdb”) instead of (“pdb”, “pdb.gz”). The gzip flag also determines the output of this function. If enabled, a triple is returned: name of the file without extension, its extension and a Boolean to tell whether the file carries the gzip extension or not. If gzip detection is turned of, only a tuple is returned: file name and extension. If the tested file name has an unrecognised extension, this function terminates the script.
Parameters: |
|
---|---|
Returns: | (base name of |
promod3.core.helper.
FileGzip
(prefix, exit_status, filename, allowed=True)¶See if a file is gzipped or not. This is basically done by checking for a “gz” suffix. May also be used to verify that a file is not compressed where it does not apply. That is where allowed comes in. If “gz” is not allowed, terminates the script on gzip files.
Parameters: |
|
---|---|
Returns: | Flag to indicate if file is gzipped ( |
Enter search terms or a module, class or function name.
pm3argparse
- Parsing Command Lines
core
- ProMod3 Core Functionality
helper
- Shared Functionality For the Everything