sysml2py

https://westfall-io.github.io/sysml2py/
Admin
sysml2py is a Python library for deserializing and working with SysML v2.0 documents, converting...
Tokens:715
Snippets:7
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### sysml2py.loads()

Source: https://westfall-io.github.io/sysml2py/index.html

Loads a SysML v2.0 model from a string.

```APIDOC
## sysml2py.loads(_s : str_)

### Description
Loads a model from string. This shortcut function allows a user to build a model from a string by first instantiating a base model class which builds out a default namespace and then that model loads all elements underneath.

### Parameters
#### Path Parameters
- **s** (str) - Required - String containing the SysML v2.0 document
```

--------------------------------

### sysml2py.load_grammar()

Source: https://westfall-io.github.io/sysml2py/index.html

Loads a SysML v2.0 document from a file pointer or a string and deserializes it into a Python dictionary object.

```APIDOC
## sysml2py.load_grammar(_fp_ , _debug =False_, _enforce =False_)

### Description
SysML load from file pointer. Deserialize `fp` (a `.read()`-supporting file-like object containing a SysML v2.0 document) or `s` (a `str` instance containing a SysML v2.0 document) to a Python dictionary object.

### Parameters
#### Path Parameters
- **fp** (__io.TextIOWrapper_ _or_ _str_) - Required - File pointer to SysML v2.0 document or string instance of SysML v2.0 document
- **debug** (bool) - Optional - Debug mode flag
- **enforce** (bool) - Optional - Enforcement flag

### Returns
Dictionary version structured utilizing SysML v2.0 grammar with some modifications to support available python libraries.

### Return Type
dict

### Raises
- **TypeError** – Input was not _io.TextIOWrapper
```

--------------------------------

### sysml2py.load()

Source: https://westfall-io.github.io/sysml2py/index.html

Loads a SysML v2.0 document from a file pointer and deserializes it into a Python dictionary object.

```APIDOC
## sysml2py.load(_fp_)

### Description
SysML load from file pointer. Deserialize `fp` (a `.read()`-supporting file-like object containing a SysML v2.0 document) to a Python dictionary object.

### Parameters
#### Path Parameters
- **fp** (__io.TextIOWrapper_) - Required - File pointer to SysML v2.0 document

### Returns
Dictionary version structured utilizing SysML v2.0 grammar with some modifications to support available python libraries.

### Return Type
dict

### Raises
- **TypeError** – Input was not _io.TextIOWrapper
```
Tokens:
Raw