Understand

https://docs.scitools.com
Admin
Understand is a comprehensive code analysis and documentation platform supporting multiple...
Tokens:123,884
Snippets:1,594
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get all functions in the project

Source: https://docs.scitools.com/manuals/python/api/understand.Db.html

Example demonstrating how to retrieve a list of all functions within the project using the understand library.

```python
import understand

# Example usage (assuming 'db' is an initialized understand.Database object)
db = understand.Database()
functions = db.ents("function")
for func in functions:
    print(f"Function: {func.name()} (ID: {func.id()})")

```

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

### Simple Table Example

Source: https://docs.scitools.com/manuals/python/api/understand.ReportContext.html

Example of creating a simple table with two columns.

```python
report.table(["Column Name 1","Column Name 2"])

```

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

### Test API Installation

Source: https://docs.scitools.com/manuals/python/_sources/index.rst.txt

Run the provided test script to verify that the Python API is correctly configured.

```console
python3 â€œC:\Program Files\SciTools\plugins\Scripts\Python\api_install_test.pyâ€
```

```console
python3 â€œC:\Program Files\SciTools\scripts\python\api_install_test.pyâ€
```

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

### Open Database Example

Source: https://docs.scitools.com/manuals/python/api/understand.Db.html

Opens a SciTools Understand database and iterates through functions.

```Python
db = understand.open("test.und")

for func in db.ents("Function"):
    # print qualified name (ex: Namespace::ClassName::methodName)
    print(func.longname())
```

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

### Basic lookup

Source: https://docs.scitools.com/manuals/python/api/understand.Db.html

A simple example of the lookup command without any special flags.

```python
db.lookup("searchstring")
```

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

### Example of using checkbox_horiz and lookup

Source: https://docs.scitools.com/manuals/python/api/understand.Options.html

Illustrates how to define a horizontal checkbox option and retrieve its selected values.

```python
# Create option with three checkboxes where items 2 and 3 are initally checked
option.checkbox_horiz("HorizCheck","Displayed Text",["Item1","Item2","Item3"],["Item2","Item3"])
# Lookup option later
option.lookup("HorizCheck")
# Returns None if nothing checked, or list of checked items such as
# ["Item1","Item2","Item3"]
```

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

### Open a project database and iterate over root architectures

Source: https://docs.scitools.com/manuals/python/_sources/index.rst.txt

Demonstrates initializing a connection to an Understand project file and accessing its top-level architecture entities.

```python
import understand

db = understand.open("/path/to/myproject.und")
for arch in db.root_archs():
    print(arch.name())
```

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

### Graph.options() Method

Source: https://docs.scitools.com/manuals/python/api/understand.Graph.html

Example of how to use the options() method to get the available options for a specific graph and target.

```python
options(_target_) → understand.Options
    
    Return options available for the given graph and target. 

Parameters:
    
**target** (_understand.Db_ _,__understand.Ent_ _, or_ _understand.Arch_) – database, entity, or architecture the graph applies to 

Return type:
    
understand.Options
```

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

### Example of setting options using a string

Source: https://docs.scitools.com/manuals/python/api/understand.Options.html

Demonstrates the format for setting multiple options using a semicolon-separated string.

```text
Layout=Crossing; name=Fullname;Level=AllLevels
Comments=On;Show Entity Name=On
```

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

### Filtered Table Example

Source: https://docs.scitools.com/manuals/python/api/understand.ReportContext.html

Example of creating an interactive table with filtering and sorting options.

```python
[{
  "name" : "Column 1",
  "filtertype": "string"
 },{ 
  "name" : "Column 2",
  "filtertype": "numeric",
  "filteroperation": ">",
  "filtervalue": 10,
  "sort": "ascending"
 },{ 
  "name" : "Column 3",
  "filtertype" : ["Yes", "No"]
}]

```

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

### Open a Project Database

Source: https://docs.scitools.com/manuals/python/_sources/index.rst.txt

Opens an Understand project database file. Ensure the database is up to date to avoid UnderstandError.

```python
import understand

db = understand.open("/path/to/myproject.und")
print(db.language())
```

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

### Git Cache Example

Source: https://docs.scitools.com/manuals/python/api/understand.Cache.html

Examples of accessing the read-only Git cache for commit, author, and date information.

```python
cache.value(ent=file,key="commits") # List of commits from newest to oldest
```

```python
cache.value(ent=file,key="authors") # List of authors corresponding to commits
```

```python
cache.value(ent=file,key="dates") # List of iso date strings corresponding to commits
```

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

### understand.license(name)

Source: https://docs.scitools.com/manuals/python/api/understand.html

Sets the STIHOME directory path for licensing configuration.

```APIDOC
## understand.license(name)

### Description
Set the STIHOME directory/path used to locate licensing configuration.

### Parameters
- **name** (str) - Required - Path to the STIHOME / license configuration directory.

### Returns
- (None)
```

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

### Get Metric Name

Source: https://docs.scitools.com/manuals/python/metric.html

Returns the name of the metric given its ID.

```python
def name(id: str) -> str:
  """
  Required, the name of the metric given by id.

  For example, CountLineCode -> "Source Lines of Code"
  """
  # This sample does not provide new names for these metrics.
  return id
```

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

### Get Metric IDs

Source: https://docs.scitools.com/manuals/python/metric.html

Returns a list of metric IDs provided by this script.

```python
def ids() -> str | tuple[str] | list[str]:
  """
  Required, a list of metric ids that this script provides

  For example, CountLineCode is a metric id.
  """
  return list(metDict.keys())
```

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

### Disable Italic Attribute

Source: https://docs.scitools.com/manuals/python/api/understand.ReportContext.html

Example showing how to disable the italic attribute, equivalent to calling report.italic(False).

```python
report.noitalic()

```

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

### understand.open(dbname)

Source: https://docs.scitools.com/manuals/python/api/understand.html

Opens an Understand database file.

```APIDOC
## understand.open(dbname)

### Description
Open a database from the passed in filename.

### Parameters
- **dbname** (str) - Required - The filename of the database.

### Returns
- (understand.Db) - An opened database object.

### Errors
- Raises Understand.Error if unable to open the database (e.g., DBAlreadyOpen, DBCorrupt, DBOldVersion, DBUnknownVersion, DBUnableOpen, NoApiLicense).
```

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

### Disable Bold Attribute

Source: https://docs.scitools.com/manuals/python/api/understand.ReportContext.html

Example showing how to disable the bold attribute, equivalent to calling report.bold(False).

```python
report.nobold()

```

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

### File Option

Source: https://docs.scitools.com/manuals/python/api/understand.Options.html

Creates a file option with a name, display text, and an optional default file path.

```python
file(_name_ , _text_ , _default_) → None¶
    
Create a file option. 

Parameters:
    
  * **name** (_str_) – the internal name to use with `lookup`
  * **text** (_str_) – the text to display next to the file entry field
  * **default** (_str_ _or_ _None_) – optional, the default file. “” if not provided


Return type:
    
None
This method was not available for `Graph` options before 7.1 (build 1221). 
```
Tokens:
Raw