symmetr.input module

Module for parsing user input.

symmetr.input.create_symmetr_input(struct, magnetic, filename=None, latt_inp_type=2, precision=0.01)

class symmetr.input.options(args)

Bases: object

Class to store all the input options.

Is meant to be used only in conjuction with the parse function. Initialize by running

opt = options(args),

where args is a dictionary of all arguments. Check method controls whether there are comflicting options, however this is not complete and it does not check whether the options have allowed values! You can access the options by:

opt[‘option’]

and also change by:

opt[‘option’] = new_value

__dict__ = mappingproxy({'__module__': 'symmetr.input', '__firstlineno__': 26, '__doc__': "Class to store all the input options.\n\nIs meant to be used only in conjuction with the parse function.\nInitialize by running\n    opt = options(args),\nwhere args is a dictionary of all arguments.\nCheck method controls whether there are comflicting options, however this is not complete and it does not\ncheck whether the options have allowed values!\nYou can access the options by:\n    opt['option']\nand also change by:\n    opt['option'] = new_value\n", '__init__': <function options.__init__>, '__setitem__': <function options.__setitem__>, '__getitem__': <function options.__getitem__>, '__str__': <function options.__str__>, 'check': <function options.check>, '__static_attributes__': ('args',), '__dict__': <attribute '__dict__' of 'options' objects>, '__weakref__': <attribute '__weakref__' of 'options' objects>, '__annotations__': {}})

__firstlineno__ = 26

__getitem__(key)

__init__(args)

During init only the mandatory arguments are set, the rest are set to default values.

__module__ = 'symmetr.input'

__setitem__(key, value)

__static_attributes__ = ('args',)

__str__()

Return str(self).

check()

symmetr.input.parse(clargs=None)

Parses the input line arguments

If clargs is not set then this parses the input arguments. Otherwise clargs is a string that contains the input arguments like on command line. :param clargs: The input arguments to be parsed. :type clargs: optional[string]