# {py:mod}`pyuvm._utility_classes`

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

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

## Module Contents

### Classes

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

* - {py:obj}`Singleton <pyuvm._utility_classes.Singleton>`
  - ```{autodoc2-docstring} pyuvm._utility_classes.Singleton
    :summary:
    ```
* - {py:obj}`Override <pyuvm._utility_classes.Override>`
  - ```{autodoc2-docstring} pyuvm._utility_classes.Override
    :summary:
    ```
* - {py:obj}`FactoryData <pyuvm._utility_classes.FactoryData>`
  - ```{autodoc2-docstring} pyuvm._utility_classes.FactoryData
    :summary:
    ```
* - {py:obj}`FactoryMeta <pyuvm._utility_classes.FactoryMeta>`
  - ```{autodoc2-docstring} pyuvm._utility_classes.FactoryMeta
    :summary:
    ```
* - {py:obj}`uvm_void <pyuvm._utility_classes.uvm_void>`
  - ```{autodoc2-docstring} pyuvm._utility_classes.uvm_void
    :summary:
    ```
* - {py:obj}`UVM_ROOT_Singleton <pyuvm._utility_classes.UVM_ROOT_Singleton>`
  -
* - {py:obj}`Objection <pyuvm._utility_classes.Objection>`
  - ```{autodoc2-docstring} pyuvm._utility_classes.Objection
    :summary:
    ```
* - {py:obj}`ObjectionHandler <pyuvm._utility_classes.ObjectionHandler>`
  - ```{autodoc2-docstring} pyuvm._utility_classes.ObjectionHandler
    :summary:
    ```
* - {py:obj}`UVMQueue <pyuvm._utility_classes.UVMQueue>`
  - ```{autodoc2-docstring} pyuvm._utility_classes.UVMQueue
    :summary:
    ```
````

### Functions

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

* - {py:obj}`count_bits <pyuvm._utility_classes.count_bits>`
  - ```{autodoc2-docstring} pyuvm._utility_classes.count_bits
    :summary:
    ```
* - {py:obj}`_get_compiled_pattern <pyuvm._utility_classes._get_compiled_pattern>`
  - ```{autodoc2-docstring} pyuvm._utility_classes._get_compiled_pattern
    :summary:
    ```
* - {py:obj}`uvm_is_match <pyuvm._utility_classes.uvm_is_match>`
  - ```{autodoc2-docstring} pyuvm._utility_classes.uvm_is_match
    :summary:
    ```
````

### Data

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

* - {py:obj}`FIFO_DEBUG <pyuvm._utility_classes.FIFO_DEBUG>`
  - ```{autodoc2-docstring} pyuvm._utility_classes.FIFO_DEBUG
    :summary:
    ```
* - {py:obj}`PYUVM_DEBUG <pyuvm._utility_classes.PYUVM_DEBUG>`
  - ```{autodoc2-docstring} pyuvm._utility_classes.PYUVM_DEBUG
    :summary:
    ```
````

### API

````{py:data} FIFO_DEBUG
:canonical: pyuvm._utility_classes.FIFO_DEBUG
:value: >
   5

```{autodoc2-docstring} pyuvm._utility_classes.FIFO_DEBUG
```

````

````{py:data} PYUVM_DEBUG
:canonical: pyuvm._utility_classes.PYUVM_DEBUG
:value: >
   4

```{autodoc2-docstring} pyuvm._utility_classes.PYUVM_DEBUG
```

````

````{py:function} count_bits(nn)
:canonical: pyuvm._utility_classes.count_bits

```{autodoc2-docstring} pyuvm._utility_classes.count_bits
```
````

`````{py:class} Singleton
:canonical: pyuvm._utility_classes.Singleton

Bases: {py:obj}`type`

```{autodoc2-docstring} pyuvm._utility_classes.Singleton
```

````{py:attribute} _instances
:canonical: pyuvm._utility_classes.Singleton._instances
:value: >
   None

```{autodoc2-docstring} pyuvm._utility_classes.Singleton._instances
```

````

````{py:method} __call__(*args, **kwargs)
:canonical: pyuvm._utility_classes.Singleton.__call__

````

````{py:method} clear_singletons(keep)
:canonical: pyuvm._utility_classes.Singleton.clear_singletons
:classmethod:

```{autodoc2-docstring} pyuvm._utility_classes.Singleton.clear_singletons
```

````

`````

`````{py:class} Override()
:canonical: pyuvm._utility_classes.Override

```{autodoc2-docstring} pyuvm._utility_classes.Override
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._utility_classes.Override.__init__
```

````{py:method} add(override, path=None)
:canonical: pyuvm._utility_classes.Override.add

```{autodoc2-docstring} pyuvm._utility_classes.Override.add
```

````

````{py:method} find_inst_override(path)
:canonical: pyuvm._utility_classes.Override.find_inst_override

```{autodoc2-docstring} pyuvm._utility_classes.Override.find_inst_override
```

````

````{py:method} __str__()
:canonical: pyuvm._utility_classes.Override.__str__

```{autodoc2-docstring} pyuvm._utility_classes.Override.__str__
```

````

`````

`````{py:class} FactoryData()
:canonical: pyuvm._utility_classes.FactoryData

```{autodoc2-docstring} pyuvm._utility_classes.FactoryData
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._utility_classes.FactoryData.__init__
```

````{py:method} clear_overrides()
:canonical: pyuvm._utility_classes.FactoryData.clear_overrides

```{autodoc2-docstring} pyuvm._utility_classes.FactoryData.clear_overrides
```

````

````{py:method} clear_classes()
:canonical: pyuvm._utility_classes.FactoryData.clear_classes

```{autodoc2-docstring} pyuvm._utility_classes.FactoryData.clear_classes
```

````

````{py:method} find_override(requested_type, inst_path=None, overridden_list=None)
:canonical: pyuvm._utility_classes.FactoryData.find_override

```{autodoc2-docstring} pyuvm._utility_classes.FactoryData.find_override
```

````

`````

````{py:class} FactoryMeta(name, bases, cls_dict)
:canonical: pyuvm._utility_classes.FactoryMeta

Bases: {py:obj}`type`

```{autodoc2-docstring} pyuvm._utility_classes.FactoryMeta
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._utility_classes.FactoryMeta.__init__
```

````

````{py:class} uvm_void
:canonical: pyuvm._utility_classes.uvm_void

```{autodoc2-docstring} pyuvm._utility_classes.uvm_void
```

````

`````{py:class} UVM_ROOT_Singleton(name, bases, cls_dict)
:canonical: pyuvm._utility_classes.UVM_ROOT_Singleton

Bases: {py:obj}`pyuvm._utility_classes.FactoryMeta`

````{py:attribute} singleton
:canonical: pyuvm._utility_classes.UVM_ROOT_Singleton.singleton
:value: >
   None

```{autodoc2-docstring} pyuvm._utility_classes.UVM_ROOT_Singleton.singleton
```

````

````{py:method} __call__(*args, **kwargs)
:canonical: pyuvm._utility_classes.UVM_ROOT_Singleton.__call__

````

````{py:method} clear_singletons()
:canonical: pyuvm._utility_classes.UVM_ROOT_Singleton.clear_singletons
:classmethod:

```{autodoc2-docstring} pyuvm._utility_classes.UVM_ROOT_Singleton.clear_singletons
```

````

`````

`````{py:class} Objection
:canonical: pyuvm._utility_classes.Objection

```{autodoc2-docstring} pyuvm._utility_classes.Objection
```

````{py:attribute} raiser_name
:canonical: pyuvm._utility_classes.Objection.raiser_name
:type: str
:value: >
   None

```{autodoc2-docstring} pyuvm._utility_classes.Objection.raiser_name
```

````

````{py:attribute} description
:canonical: pyuvm._utility_classes.Objection.description
:type: str
:value: >
   None

```{autodoc2-docstring} pyuvm._utility_classes.Objection.description
```

````

````{py:attribute} sourceline
:canonical: pyuvm._utility_classes.Objection.sourceline
:type: str
:value: >
   None

```{autodoc2-docstring} pyuvm._utility_classes.Objection.sourceline
```

````

````{py:method} __str__()
:canonical: pyuvm._utility_classes.Objection.__str__

````

`````

`````{py:class} ObjectionHandler()
:canonical: pyuvm._utility_classes.ObjectionHandler

```{autodoc2-docstring} pyuvm._utility_classes.ObjectionHandler
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._utility_classes.ObjectionHandler.__init__
```

````{py:method} __str__()
:canonical: pyuvm._utility_classes.ObjectionHandler.__str__

```{autodoc2-docstring} pyuvm._utility_classes.ObjectionHandler.__str__
```

````

````{py:method} clear()
:canonical: pyuvm._utility_classes.ObjectionHandler.clear

```{autodoc2-docstring} pyuvm._utility_classes.ObjectionHandler.clear
```

````

````{py:method} raise_objection(raiser, description, stacklevel=1)
:canonical: pyuvm._utility_classes.ObjectionHandler.raise_objection

```{autodoc2-docstring} pyuvm._utility_classes.ObjectionHandler.raise_objection
```

````

````{py:method} drop_objection(dropper, description)
:canonical: pyuvm._utility_classes.ObjectionHandler.drop_objection

```{autodoc2-docstring} pyuvm._utility_classes.ObjectionHandler.drop_objection
```

````

````{py:method} run_phase_complete()
:canonical: pyuvm._utility_classes.ObjectionHandler.run_phase_complete
:async:

```{autodoc2-docstring} pyuvm._utility_classes.ObjectionHandler.run_phase_complete
```

````

`````

`````{py:class} UVMQueue(maxsize: int = 0)
:canonical: pyuvm._utility_classes.UVMQueue

Bases: {py:obj}`cocotb.queue.Queue`

```{autodoc2-docstring} pyuvm._utility_classes.UVMQueue
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyuvm._utility_classes.UVMQueue.__init__
```

````{py:method} __str__()
:canonical: pyuvm._utility_classes.UVMQueue.__str__

````

````{py:method} _peek()
:canonical: pyuvm._utility_classes.UVMQueue._peek

```{autodoc2-docstring} pyuvm._utility_classes.UVMQueue._peek
```

````

````{py:method} peek()
:canonical: pyuvm._utility_classes.UVMQueue.peek
:async:

```{autodoc2-docstring} pyuvm._utility_classes.UVMQueue.peek
```

````

````{py:method} peek_nowait()
:canonical: pyuvm._utility_classes.UVMQueue.peek_nowait

```{autodoc2-docstring} pyuvm._utility_classes.UVMQueue.peek_nowait
```

````

`````

````{py:function} _get_compiled_pattern(expr: str)
:canonical: pyuvm._utility_classes._get_compiled_pattern

```{autodoc2-docstring} pyuvm._utility_classes._get_compiled_pattern
```
````

````{py:function} uvm_is_match(expr: str, string: str) -> bool
:canonical: pyuvm._utility_classes.uvm_is_match

```{autodoc2-docstring} pyuvm._utility_classes.uvm_is_match
```
````