File: tooling.py

package info (click to toggle)
argparse-manpage 4.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 536 kB
  • sloc: python: 2,755; makefile: 47; sh: 18
file content (79 lines) | stat: -rw-r--r-- 2,326 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
"""
A tooling helpers for the argparse-manpage project.
"""

import importlib
import os
import sys

from .compat import load_file_as_module, get_module_object


def _environ_hack():
    os.environ['BUILD_MANPAGES_RUNNING'] = 'TRUE'


def get_parser_from_module(module, objname, objtype='object', prog=None):
    """
    Read the given module and return the requested object from there.
    """
    _environ_hack()
    # We need to set argv[0] to properly so argparse returns appropriate "usage"
    # strings.  Like "usage: argparse-manpage [-h] ...", instead of
    # "usage: setup.py ...".
    backup_argv = sys.argv
    if prog:
        sys.argv = [prog]

    mod = importlib.import_module(module)
    obj = get_module_object(mod, objname, objtype)

    # Restore callee's argv
    sys.argv = backup_argv
    return obj


def get_parser_from_file(filename, objname, objtype='object', prog=None):
    """
    Load the given filename as a module and return the requested object from
    there.
    """
    _environ_hack()
    # We need to set argv[0] to properly so argparse returns appropriate "usage"
    # strings.  Like "usage: argparse-manpage [-h] ...", instead of
    # "usage: setup.py ...".
    backup_argv = sys.argv
    if prog:
        sys.argv = [prog]
    else:
        sys.argv = [os.path.basename(filename)]

    # Get the ArgumentParser object
    module_loaded = load_file_as_module(filename)
    obj = get_module_object(module_loaded, objname, objtype)

    # Restore callee's argv
    sys.argv = backup_argv
    return obj


def get_parser(import_type, import_from, objname, objtype, prog=None):
    """
    Load a function or object from a given file or module.
    """
    if import_type == 'pyfile':
        return get_parser_from_file(import_from, objname, objtype, prog=prog)
    return get_parser_from_module(import_from, objname, objtype, prog=prog)


def write_to_filename(text, filename):
    """
    Write given text into a filename at once.  Pre-create the parent directory
    if it doesn't exist yet.  Print to stdout if filename == '-'.
    """
    filename = filename if filename != '-' else '/dev/stdout'
    dirname = os.path.dirname(filename)
    if dirname and not os.path.exists(dirname):
        os.makedirs(dirname)
    with open(filename, 'w') as stream:
        stream.write(text)