Generates state chart in .dot format of ragel state machine.
rageldot.rl.dot| Setting | Description | Default |
|---|---|---|
| add-new-files | Boolean or list of extensions/patterns to match. | False |
| added-in-version | Dexy version when this filter was first available. | |
| additional-doc-filters | Filters to apply to additional documents created as side effects. | {} |
| additional-doc-settings | Settings to apply to additional documents created as side effects. | {} |
| args | Arguments to be passed to the executable. | |
| check-return-code | Whether to look for nonzero return code. | True |
| clargs | Arguments to be passed to the executable (same as 'args'). | |
| command-string | The full command string. | %(prog)s %(args)s -V "%(script_file)s" -o "%(output_file)s" |
| data-type | Alias of custom data class to use to store filter output. | generic |
| env | Dictionary of key-value pairs to be added to environment for runs. | {} |
| examples | Templates which should be used as examples for this filter. | [] |
| exclude-add-new-files | List of patterns to skip even if they match add-new-files. | [] |
| exclude-new-files-from-dir | List of directories to skip when adding new files. | [] |
| executable | The executable to be run | ragel |
| ext | File extension to output. | None |
| extension-map | Dictionary mapping input extensions to default output extensions. | None |
| help | Help string for filter, if not already specified as a class docstring. | Generates state chart in .dot format of ragel state machine. |
| initial-timeout | 10 | |
| input-extensions | List of extensions which this filter can accept as input. | ['.rl'] |
| install-dir | /usr/local/lib/python3.8/site-packages/dexy/filters | |
| keep-originals | Whether, if additional-doc-filters are specified, the original unmodified docs should also be added. | False |
| make-dummy-output | Whether to make a dummy output file when one is not generated and add-new-files is True. | False |
| mkdir | A directory which should be created in working dir. | None |
| mkdirs | A list of directories which should be created in working dir. | [] |
| nodoc | Whether filter should be excluded from documentation. | False |
| output | Whether to output results of this filter by default by reporters such as 'output' or 'website'. | False |
| output-extensions | List of extensions which this filter can produce as output. | ['.dot'] |
| override-workspace-exclude-filters | If True, document will be populated to other workspaces ignoring workspace-exclude-filters. | False |
| path-extensions | strings to extend path with | [] |
| preserve-prior-data-class | Whether output data class should be set to match the input data class. | False |
| record-vars | Whether to add code that will automatically record values of variables. | False |
| require-output | Should dexy raise an exception if no output is produced by this filter? | True |
| scriptargs | Arguments to be passed to the executable. | |
| tags | Tags which describe the filter. | ['ragel', 'parser', 'dot'] |
| timeout | 10 | |
| use-wd | Whether to use a custom working directory when running filter. | True |
| variables | A dictionary of variable names and values to make available to this filter. | {} |
| vars | A dictionary of variable names and values to make available to this filter. | {} |
| version-command | Command to call to return version of installed software. | ragel --version |
| windows-version-command | Command to call on windows to return version of installed software. | None |
| workspace-exclude-filters | Filters whose output should be excluded from workspace. | ['pyg'] |
| workspace-includes | If set to a list of filenames or extensions, only these will be populated to working dir. | None |
| write-stderr-to-stdout | Should stderr be piped to stdout? | True |
Content © 2020 Dr. Ana Nelson | Site Design © Copyright 2011 Andre Gagnon | All Rights Reserved.