# {py:mod}`pyirk._builtin.scopes`

```{py:module} pyirk._builtin.scopes
```

```{autodoc2-docstring} pyirk._builtin.scopes
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`ScopingCM <pyirk._builtin.scopes.ScopingCM>`
  - ```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM
    :summary:
    ```
* - {py:obj}`AbstractMathRelatedScopeCM <pyirk._builtin.scopes.AbstractMathRelatedScopeCM>`
  - ```{autodoc2-docstring} pyirk._builtin.scopes.AbstractMathRelatedScopeCM
    :summary:
    ```
* - {py:obj}`ConditionSubScopeCM <pyirk._builtin.scopes.ConditionSubScopeCM>`
  - ```{autodoc2-docstring} pyirk._builtin.scopes.ConditionSubScopeCM
    :summary:
    ```
* - {py:obj}`QuantifiedSubScopeCM <pyirk._builtin.scopes.QuantifiedSubScopeCM>`
  - ```{autodoc2-docstring} pyirk._builtin.scopes.QuantifiedSubScopeCM
    :summary:
    ```
````

### Functions

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

* - {py:obj}`_register_scope <pyirk._builtin.scopes._register_scope>`
  - ```{autodoc2-docstring} pyirk._builtin.scopes._register_scope
    :summary:
    ```
* - {py:obj}`add_relations_to_scope <pyirk._builtin.scopes.add_relations_to_scope>`
  - ```{autodoc2-docstring} pyirk._builtin.scopes.add_relations_to_scope
    :summary:
    ```
* - {py:obj}`get_scopes <pyirk._builtin.scopes.get_scopes>`
  - ```{autodoc2-docstring} pyirk._builtin.scopes.get_scopes
    :summary:
    ```
* - {py:obj}`get_items_defined_in_scope <pyirk._builtin.scopes.get_items_defined_in_scope>`
  - ```{autodoc2-docstring} pyirk._builtin.scopes.get_items_defined_in_scope
    :summary:
    ```
* - {py:obj}`_get_subscopes <pyirk._builtin.scopes._get_subscopes>`
  - ```{autodoc2-docstring} pyirk._builtin.scopes._get_subscopes
    :summary:
    ```
* - {py:obj}`_get_subscope <pyirk._builtin.scopes._get_subscope>`
  - ```{autodoc2-docstring} pyirk._builtin.scopes._get_subscope
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <pyirk._builtin.scopes.__all__>`
  - ```{autodoc2-docstring} pyirk._builtin.scopes.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: pyirk._builtin.scopes.__all__
:value: >
   ['_register_scope', 'add_relations_to_scope', 'get_scopes', 'get_items_defined_in_scope', 'ScopingCM...

```{autodoc2-docstring} pyirk._builtin.scopes.__all__
```

````

````{py:function} _register_scope(self, name: str, scope_type: str = None) -> tuple[dict, pyirk.core.Item]
:canonical: pyirk._builtin.scopes._register_scope

```{autodoc2-docstring} pyirk._builtin.scopes._register_scope
```
````

````{py:function} add_relations_to_scope(relation_tuples: typing.Union[list, tuple], scope: pyirk.core.Entity)
:canonical: pyirk._builtin.scopes.add_relations_to_scope

```{autodoc2-docstring} pyirk._builtin.scopes.add_relations_to_scope
```
````

````{py:function} get_scopes(entity: pyirk.core.Entity) -> typing.List[pyirk.core.Item]
:canonical: pyirk._builtin.scopes.get_scopes

```{autodoc2-docstring} pyirk._builtin.scopes.get_scopes
```
````

````{py:function} get_items_defined_in_scope(scope: pyirk.core.Item) -> typing.List[pyirk.core.Entity]
:canonical: pyirk._builtin.scopes.get_items_defined_in_scope

```{autodoc2-docstring} pyirk._builtin.scopes.get_items_defined_in_scope
```
````

`````{py:class} ScopingCM(itm: pyirk.core.Item, namespace: dict, scope: pyirk.core.Item, parent_scope_cm=None)
:canonical: pyirk._builtin.scopes.ScopingCM

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM.__init__
```

````{py:attribute} _all_instances
:canonical: pyirk._builtin.scopes.ScopingCM._all_instances
:value: >
   []

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM._all_instances
```

````

````{py:attribute} _instances
:canonical: pyirk._builtin.scopes.ScopingCM._instances
:value: >
   'defaultdict(...)'

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM._instances
```

````

````{py:attribute} valid_subscope_types
:canonical: pyirk._builtin.scopes.ScopingCM.valid_subscope_types
:value: >
   None

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM.valid_subscope_types
```

````

````{py:method} __enter__()
:canonical: pyirk._builtin.scopes.ScopingCM.__enter__

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM.__enter__
```

````

````{py:method} __exit__(exc_type, exc_val, exc_tb)
:canonical: pyirk._builtin.scopes.ScopingCM.__exit__

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM.__exit__
```

````

````{py:method} __getattr__(name: str)
:canonical: pyirk._builtin.scopes.ScopingCM.__getattr__

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM.__getattr__
```

````

````{py:method} new_var(**kwargs) -> pyirk.core.Entity
:canonical: pyirk._builtin.scopes.ScopingCM.new_var

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM.new_var
```

````

````{py:method} _new_var(variable_name: str, variable_object: pyirk.core.Entity) -> pyirk.core.Entity
:canonical: pyirk._builtin.scopes.ScopingCM._new_var

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM._new_var
```

````

````{py:method} new_rel(sub: pyirk.core.Entity, pred: pyirk.core.Relation, obj: pyirk.core.Entity, qualifiers=None, overwrite=False) -> pyirk.core.Statement
:canonical: pyirk._builtin.scopes.ScopingCM.new_rel

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM.new_rel
```

````

````{py:method} _check_scope()
:canonical: pyirk._builtin.scopes.ScopingCM._check_scope

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM._check_scope
```

````

````{py:method} _create_subscope_cm(scope_type: str, cls: type)
:canonical: pyirk._builtin.scopes.ScopingCM._create_subscope_cm

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM._create_subscope_cm
```

````

````{py:method} copy_from(other_obj: pyirk.core.Item, scope_name: str = None)
:canonical: pyirk._builtin.scopes.ScopingCM.copy_from

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM.copy_from
```

````

````{py:method} _get_new_var_from_old(old_var: pyirk.core.Item, strict=False) -> pyirk.core.Item
:canonical: pyirk._builtin.scopes.ScopingCM._get_new_var_from_old

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM._get_new_var_from_old
```

````

````{py:method} _copy_mapping(mapping_item: pyirk.core.Item) -> pyirk.core.Item
:canonical: pyirk._builtin.scopes.ScopingCM._copy_mapping

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM._copy_mapping
```

````

````{py:method} _get_premise_vars() -> dict
:canonical: pyirk._builtin.scopes.ScopingCM._get_premise_vars

```{autodoc2-docstring} pyirk._builtin.scopes.ScopingCM._get_premise_vars
```

````

`````

`````{py:class} AbstractMathRelatedScopeCM(itm: pyirk.core.Item, namespace: dict, scope: pyirk.core.Item, parent_scope_cm=None)
:canonical: pyirk._builtin.scopes.AbstractMathRelatedScopeCM

Bases: {py:obj}`pyirk._builtin.scopes.ScopingCM`

```{autodoc2-docstring} pyirk._builtin.scopes.AbstractMathRelatedScopeCM
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk._builtin.scopes.AbstractMathRelatedScopeCM.__init__
```

````{py:method} new_equation(lhs: pyirk.core.Item, rhs: pyirk.core.Item, force_key: str = None) -> pyirk.core.Item
:canonical: pyirk._builtin.scopes.AbstractMathRelatedScopeCM.new_equation

```{autodoc2-docstring} pyirk._builtin.scopes.AbstractMathRelatedScopeCM.new_equation
```

````

````{py:method} new_math_relation(lhs: pyirk.core.Item, rsgn: str, rhs: pyirk.core.Item, add_relations: dict = {}, force_key: str = None) -> pyirk.core.Item
:canonical: pyirk._builtin.scopes.AbstractMathRelatedScopeCM.new_math_relation

```{autodoc2-docstring} pyirk._builtin.scopes.AbstractMathRelatedScopeCM.new_math_relation
```

````

````{py:method} AND() -> pyirk._builtin.scopes.ConditionSubScopeCM
:canonical: pyirk._builtin.scopes.AbstractMathRelatedScopeCM.AND

```{autodoc2-docstring} pyirk._builtin.scopes.AbstractMathRelatedScopeCM.AND
```

````

````{py:method} OR() -> pyirk._builtin.scopes.ConditionSubScopeCM
:canonical: pyirk._builtin.scopes.AbstractMathRelatedScopeCM.OR

```{autodoc2-docstring} pyirk._builtin.scopes.AbstractMathRelatedScopeCM.OR
```

````

````{py:method} NOT() -> pyirk._builtin.scopes.ConditionSubScopeCM
:canonical: pyirk._builtin.scopes.AbstractMathRelatedScopeCM.NOT

```{autodoc2-docstring} pyirk._builtin.scopes.AbstractMathRelatedScopeCM.NOT
```

````

````{py:method} check_scope_type(*args, **kwargs)
:canonical: pyirk._builtin.scopes.AbstractMathRelatedScopeCM.check_scope_type

```{autodoc2-docstring} pyirk._builtin.scopes.AbstractMathRelatedScopeCM.check_scope_type
```

````

`````

`````{py:class} ConditionSubScopeCM(*args, **kwargs)
:canonical: pyirk._builtin.scopes.ConditionSubScopeCM

Bases: {py:obj}`pyirk._builtin.scopes.AbstractMathRelatedScopeCM`

```{autodoc2-docstring} pyirk._builtin.scopes.ConditionSubScopeCM
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk._builtin.scopes.ConditionSubScopeCM.__init__
```

````{py:attribute} valid_subscope_types
:canonical: pyirk._builtin.scopes.ConditionSubScopeCM.valid_subscope_types
:value: >
   None

```{autodoc2-docstring} pyirk._builtin.scopes.ConditionSubScopeCM.valid_subscope_types
```

````

````{py:method} add_condition_statement(subj, pred, obj, qualifiers=None)
:canonical: pyirk._builtin.scopes.ConditionSubScopeCM.add_condition_statement

```{autodoc2-docstring} pyirk._builtin.scopes.ConditionSubScopeCM.add_condition_statement
```

````

````{py:method} add_condition_math_relation(*args, **kwargs)
:canonical: pyirk._builtin.scopes.ConditionSubScopeCM.add_condition_math_relation

```{autodoc2-docstring} pyirk._builtin.scopes.ConditionSubScopeCM.add_condition_math_relation
```

````

````{py:method} new_condition_var(**kwargs)
:canonical: pyirk._builtin.scopes.ConditionSubScopeCM.new_condition_var

```{autodoc2-docstring} pyirk._builtin.scopes.ConditionSubScopeCM.new_condition_var
```

````

````{py:method} check_scope_type(forbidden)
:canonical: pyirk._builtin.scopes.ConditionSubScopeCM.check_scope_type

````

`````

````{py:class} QuantifiedSubScopeCM(*args, **kwargs)
:canonical: pyirk._builtin.scopes.QuantifiedSubScopeCM

Bases: {py:obj}`pyirk._builtin.scopes.ConditionSubScopeCM`

```{autodoc2-docstring} pyirk._builtin.scopes.QuantifiedSubScopeCM
```

```{rubric} Initialization
```

```{autodoc2-docstring} pyirk._builtin.scopes.QuantifiedSubScopeCM.__init__
```

````

````{py:function} _get_subscopes(self)
:canonical: pyirk._builtin.scopes._get_subscopes

```{autodoc2-docstring} pyirk._builtin.scopes._get_subscopes
```
````

````{py:function} _get_subscope(self, name: str)
:canonical: pyirk._builtin.scopes._get_subscope

```{autodoc2-docstring} pyirk._builtin.scopes._get_subscope
```
````