# {py:mod}`pyuvm._s13_uvm_component`

```{py:module} pyuvm._s13_uvm_component
```

```{autodoc2-docstring} pyuvm._s13_uvm_component
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`uvm_component <pyuvm._s13_uvm_component.uvm_component>`
  -
* - {py:obj}`uvm_test <pyuvm._s13_uvm_component.uvm_test>`
  - ```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_test
    :summary:
    ```
* - {py:obj}`uvm_root <pyuvm._s13_uvm_component.uvm_root>`
  - ```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_root
    :summary:
    ```
* - {py:obj}`ConfigDB <pyuvm._s13_uvm_component.ConfigDB>`
  - ```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB
    :summary:
    ```
* - {py:obj}`uvm_config_db <pyuvm._s13_uvm_component.uvm_config_db>`
  - ```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_config_db
    :summary:
    ```
````

### API

`````{py:class} uvm_component(name, parent)
:canonical: pyuvm._s13_uvm_component.uvm_component

Bases: {py:obj}`pyuvm._s06_reporting_classes.uvm_report_object`

````{py:attribute} component_dict
:canonical: pyuvm._s13_uvm_component.uvm_component.component_dict
:value: >
   None

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.component_dict
```

````

````{py:method} clear_components()
:canonical: pyuvm._s13_uvm_component.uvm_component.clear_components
:classmethod:

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.clear_components
```

````

````{py:method} clear_children()
:canonical: pyuvm._s13_uvm_component.uvm_component.clear_children

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.clear_children
```

````

````{py:method} clear_hierarchy()
:canonical: pyuvm._s13_uvm_component.uvm_component.clear_hierarchy

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.clear_hierarchy
```

````

````{py:method} do_execute_op(op)
:canonical: pyuvm._s13_uvm_component.uvm_component.do_execute_op

````

````{py:method} create(name='', parent=None)
:canonical: pyuvm._s13_uvm_component.uvm_component.create
:classmethod:

````

````{py:method} get_parent()
:canonical: pyuvm._s13_uvm_component.uvm_component.get_parent

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.get_parent
```

````

````{py:method} raise_objection(description='', stacklevel=1)
:canonical: pyuvm._s13_uvm_component.uvm_component.raise_objection

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.raise_objection
```

````

````{py:method} drop_objection(description='')
:canonical: pyuvm._s13_uvm_component.uvm_component.drop_objection

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.drop_objection
```

````

````{py:method} objection()
:canonical: pyuvm._s13_uvm_component.uvm_component.objection

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.objection
```

````

````{py:method} cdb_set(label, value, inst_path='*')
:canonical: pyuvm._s13_uvm_component.uvm_component.cdb_set

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.cdb_set
```

````

````{py:method} cdb_get(label, inst_path='')
:canonical: pyuvm._s13_uvm_component.uvm_component.cdb_get

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.cdb_get
```

````

````{py:property} parent
:canonical: pyuvm._s13_uvm_component.uvm_component.parent

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.parent
```

````

````{py:method} get_full_name()
:canonical: pyuvm._s13_uvm_component.uvm_component.get_full_name

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.get_full_name
```

````

````{py:method} get_children()
:canonical: pyuvm._s13_uvm_component.uvm_component.get_children

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.get_children
```

````

````{py:method} add_child(name, child)
:canonical: pyuvm._s13_uvm_component.uvm_component.add_child

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.add_child
```

````

````{py:property} hierarchy
:canonical: pyuvm._s13_uvm_component.uvm_component.hierarchy

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.hierarchy
```

````

````{py:property} children
:canonical: pyuvm._s13_uvm_component.uvm_component.children

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.children
```

````

````{py:method} __repr__()
:canonical: pyuvm._s13_uvm_component.uvm_component.__repr__

````

````{py:method} get_child(name)
:canonical: pyuvm._s13_uvm_component.uvm_component.get_child

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.get_child
```

````

````{py:method} get_num_children()
:canonical: pyuvm._s13_uvm_component.uvm_component.get_num_children

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.get_num_children
```

````

````{py:method} has_child(name)
:canonical: pyuvm._s13_uvm_component.uvm_component.has_child

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.has_child
```

````

````{py:method} lookup(name)
:canonical: pyuvm._s13_uvm_component.uvm_component.lookup

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.lookup
```

````

````{py:method} get_depth()
:canonical: pyuvm._s13_uvm_component.uvm_component.get_depth

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.get_depth
```

````

````{py:method} set_logging_level_hier(logging_level)
:canonical: pyuvm._s13_uvm_component.uvm_component.set_logging_level_hier

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.set_logging_level_hier
```

````

````{py:method} add_logging_handler_hier(handler)
:canonical: pyuvm._s13_uvm_component.uvm_component.add_logging_handler_hier

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.add_logging_handler_hier
```

````

````{py:method} remove_logging_handler_hier(handler)
:canonical: pyuvm._s13_uvm_component.uvm_component.remove_logging_handler_hier

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.remove_logging_handler_hier
```

````

````{py:method} remove_streaming_handler_hier()
:canonical: pyuvm._s13_uvm_component.uvm_component.remove_streaming_handler_hier

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.remove_streaming_handler_hier
```

````

````{py:method} disable_logging_hier()
:canonical: pyuvm._s13_uvm_component.uvm_component.disable_logging_hier

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.disable_logging_hier
```

````

````{py:method} build_phase()
:canonical: pyuvm._s13_uvm_component.uvm_component.build_phase

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.build_phase
```

````

````{py:method} connect_phase()
:canonical: pyuvm._s13_uvm_component.uvm_component.connect_phase

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.connect_phase
```

````

````{py:method} end_of_elaboration_phase()
:canonical: pyuvm._s13_uvm_component.uvm_component.end_of_elaboration_phase

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.end_of_elaboration_phase
```

````

````{py:method} start_of_simulation_phase()
:canonical: pyuvm._s13_uvm_component.uvm_component.start_of_simulation_phase

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.start_of_simulation_phase
```

````

````{py:method} run_phase()
:canonical: pyuvm._s13_uvm_component.uvm_component.run_phase
:async:

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.run_phase
```

````

````{py:method} extract_phase()
:canonical: pyuvm._s13_uvm_component.uvm_component.extract_phase

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.extract_phase
```

````

````{py:method} check_phase()
:canonical: pyuvm._s13_uvm_component.uvm_component.check_phase

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.check_phase
```

````

````{py:method} report_phase()
:canonical: pyuvm._s13_uvm_component.uvm_component.report_phase

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.report_phase
```

````

````{py:method} final_phase()
:canonical: pyuvm._s13_uvm_component.uvm_component.final_phase

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_component.final_phase
```

````

`````

````{py:class} uvm_test(name, parent)
:canonical: pyuvm._s13_uvm_component.uvm_test

Bases: {py:obj}`pyuvm._s13_uvm_component.uvm_component`

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_test
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_test.__init__
```

````

`````{py:class} uvm_root()
:canonical: pyuvm._s13_uvm_component.uvm_root

Bases: {py:obj}`pyuvm._s13_uvm_component.uvm_component`

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_root
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_root.__init__
```

````{py:method} clear_singletons(keep_set={})
:canonical: pyuvm._s13_uvm_component.uvm_root.clear_singletons
:classmethod:

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_root.clear_singletons
```

````

````{py:method} _utt()
:canonical: pyuvm._s13_uvm_component.uvm_root._utt

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_root._utt
```

````

````{py:method} run_test(test_name, keep_singletons=False, keep_set=set())
:canonical: pyuvm._s13_uvm_component.uvm_root.run_test
:async:

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_root.run_test
```

````

````{py:method} _find_all_recurse(comp_match, comp) -> list[pyuvm._s13_uvm_component.uvm_component]
:canonical: pyuvm._s13_uvm_component.uvm_root._find_all_recurse

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_root._find_all_recurse
```

````

````{py:method} find_all(comp_match: str, comp: pyuvm._s13_uvm_component.uvm_component | None = None) -> list[pyuvm._s13_uvm_component.uvm_component]
:canonical: pyuvm._s13_uvm_component.uvm_root.find_all

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_root.find_all
```

````

````{py:method} find(comp_match: str) -> pyuvm._s13_uvm_component.uvm_component | None
:canonical: pyuvm._s13_uvm_component.uvm_root.find

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_root.find
```

````

`````

`````{py:class} ConfigDB()
:canonical: pyuvm._s13_uvm_component.ConfigDB

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB.__init__
```

````{py:attribute} default_get
:canonical: pyuvm._s13_uvm_component.ConfigDB.default_get
:value: >
   'object(...)'

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB.default_get
```

````

````{py:attribute} default_precedence
:canonical: pyuvm._s13_uvm_component.ConfigDB.default_precedence
:value: >
   1000

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB.default_precedence
```

````

````{py:attribute} legal_chars
:canonical: pyuvm._s13_uvm_component.ConfigDB.legal_chars
:value: >
   None

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB.legal_chars
```

````

````{py:method} clear()
:canonical: pyuvm._s13_uvm_component.ConfigDB.clear

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB.clear
```

````

````{py:method} _get_context_inst_name(context, inst_name)
:canonical: pyuvm._s13_uvm_component.ConfigDB._get_context_inst_name
:staticmethod:

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB._get_context_inst_name
```

````

````{py:method} _get_event_key(context, inst_name, field_name)
:canonical: pyuvm._s13_uvm_component.ConfigDB._get_event_key

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB._get_event_key
```

````

````{py:method} trace(method, context, inst_name, field_name, value)
:canonical: pyuvm._s13_uvm_component.ConfigDB.trace

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB.trace
```

````

````{py:method} set(context, inst_name, field_name, value)
:canonical: pyuvm._s13_uvm_component.ConfigDB.set

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB.set
```

````

````{py:method} get(context, inst_name, field_name, default=default_get)
:canonical: pyuvm._s13_uvm_component.ConfigDB.get

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB.get
```

````

````{py:method} _not_found(msg, default)
:canonical: pyuvm._s13_uvm_component.ConfigDB._not_found

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB._not_found
```

````

````{py:method} exists(context, inst_name, field_name)
:canonical: pyuvm._s13_uvm_component.ConfigDB.exists

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB.exists
```

````

````{py:method} wait_modified(context, inst_name, field_name)
:canonical: pyuvm._s13_uvm_component.ConfigDB.wait_modified
:async:

```{autodoc2-docstring} pyuvm._s13_uvm_component.ConfigDB.wait_modified
```

````

````{py:method} __str__()
:canonical: pyuvm._s13_uvm_component.ConfigDB.__str__

````

`````

`````{py:class} uvm_config_db
:canonical: pyuvm._s13_uvm_component.uvm_config_db

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_config_db
```

````{py:method} set(cntxt: pyuvm._s13_uvm_component.uvm_component | None, inst_name: str, field_name: str, value: typing.Any) -> None
:canonical: pyuvm._s13_uvm_component.uvm_config_db.set
:classmethod:

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_config_db.set
```

````

````{py:method} get(cntxt: pyuvm._s13_uvm_component.uvm_component | None, inst_name: str, field_name: str, default: typing.Any = ConfigDB().default_get) -> typing.Any
:canonical: pyuvm._s13_uvm_component.uvm_config_db.get
:classmethod:

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_config_db.get
```

````

````{py:method} exists(cntxt: pyuvm._s13_uvm_component.uvm_component | None, inst_name: str, field_name: str) -> bool
:canonical: pyuvm._s13_uvm_component.uvm_config_db.exists
:classmethod:

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_config_db.exists
```

````

````{py:method} wait_modified(cntxt: pyuvm._s13_uvm_component.uvm_component | None, inst_name: str, field_name: str)
:canonical: pyuvm._s13_uvm_component.uvm_config_db.wait_modified
:async:
:classmethod:

```{autodoc2-docstring} pyuvm._s13_uvm_component.uvm_config_db.wait_modified
```

````

`````