CollectionRule#

pydantic model mobu.models.business.notebookrunner.CollectionRule#

A set of patterns to filter the list of notebooks to run in a repo.

Parameters:

data (Any)

Show JSON schema
{
   "title": "CollectionRule",
   "description": "A set of patterns to filter the list of notebooks to run in a repo.",
   "type": "object",
   "properties": {
      "type": {
         "description": "intersect_union_of will evaluate the intersection of the current collection in the rule evaluation chain with union of all of the patterns in this rule. 'exclude_union_of' will subtract the union of the notebooks found by any pattern in this rule from the current current collection in the rule chain.",
         "enum": [
            "intersect_union_of",
            "exclude_union_of"
         ],
         "title": "Collection rule type",
         "type": "string"
      },
      "patterns": {
         "description": "A set of Python pathlib glob patterns: https://docs.python.org/3/library/pathlib.html#pattern-language This rule will gather all of the notebooks matched by any pattern in this list to either intersect or exclude.",
         "items": {
            "type": "string"
         },
         "title": "patterns",
         "type": "array",
         "uniqueItems": true
      }
   },
   "required": [
      "type",
      "patterns"
   ]
}

Fields:
field patterns: set[str] [Required]#

A set of Python pathlib glob patterns: https://docs.python.org/3/library/pathlib.html#pattern-language This rule will gather all of the notebooks matched by any pattern in this list to either intersect or exclude.

field type: Literal['intersect_union_of', 'exclude_union_of'] [Required]#

intersect_union_of will evaluate the intersection of the current collection in the rule evaluation chain with union of all of the patterns in this rule. ‘exclude_union_of’ will subtract the union of the notebooks found by any pattern in this rule from the current current collection in the rule chain.