ExportOptions

class ExportOptions

Parsed arguments for the syside reqif export subcommand.

Members defined in ExportOptions (8 members)

	attachments_dir	RW	Directory to collect ReqIF attachments into. When None, defaults to <cwd>/ joined with syside.reqif.ATTACHMENTS_DIR at run time (--attachments-dir).
	comment	RW	Human-readable free-form description of the ReqIF Exchange Document. Optional.
	file	RW	Path to the exported .reqif or .reqifz file.
	progress_interval	RW	Items between progress updates when stdout is not a TTY. 0 disables progress output entirely. On a TTY, rich renders a live bar regardless of this value (--progress-interval).
	repository_id	RW	Identifier of the repository from which this ReqIF Exchange Document was created. E.g. a UUID, URL. Optional.
	reqifz	RW	Whether to export as .reqifz or .reqif. Default: False.
	title	RW	Human-readable title for the ReqIF Exchange Document. Required.
	add_args		Register this subcommand’s flags onto parser.

Members inherited from OptionsBase (1 member)



from_args

RW

Build an options instance by pulling each dataclass field off args.

 Attributes

attachments_dir: pathlib.Path | None = None

Directory to collect ReqIF attachments into. When None, defaults to <cwd>/ joined with syside.reqif.ATTACHMENTS_DIR at run time (--attachments-dir).

Note: collection is dumb – it will collect all files in the directory regardless of whether they are mentioned in the SysMLv2 model or not. Avoid setting this path to the current working directory, as it will collect all SysMLv2 files as well.

comment: str | None = None

Human-readable free-form description of the ReqIF Exchange Document. Optional.

file: pathlib.Path = None

Path to the exported .reqif or .reqifz file.

progress_interval: int = 1000

Items between progress updates when stdout is not a TTY. 0 disables progress output entirely. On a TTY, rich renders a live bar regardless of this value (--progress-interval).

repository_id: str | None = None

Identifier of the repository from which this ReqIF Exchange Document was created. E.g. a UUID, URL. Optional.

reqifz: bool = None

Whether to export as .reqifz or .reqif. Default: False.

title: str = None

Human-readable title for the ReqIF Exchange Document. Required.

 Methods

static add_args(parser: argparse.ArgumentParser) → None

Register this subcommand’s flags onto parser.

 Used in

• syside.reqif

  • export