Skip to content

CustomPattern

Source code in docs_src/capo_workspaces_web/types/custom_pattern.py 
15
16
17
18
19
20
21
22
23
24
25
class CustomPattern(TypedDict, closed=True):
    pattern_name: "capo_workspaces_web.types.pattern_name.PatternName"
    """<p>The pattern name for the custom pattern.</p>"""
    pattern_regex: "capo_workspaces_web.types.regex.Regex"
    """<p>The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”.</p>"""
    pattern_description: NotRequired[
        "capo_workspaces_web.types.description_safe.DescriptionSafe"
    ]
    """<p>The pattern description for the customer pattern.</p>"""
    keyword_regex: NotRequired["capo_workspaces_web.types.regex.Regex"]
    """<p>The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi”</p>"""

keyword_regex instance-attribute 

keyword_regex: NotRequired[Regex]

The keyword regex for the customer pattern. After there is a match to the pattern regex, the keyword regex is used to search within the proximity of the match. If there is a keyword match, then the match is confirmed. If no keyword regex is provided, the pattern regex match will automatically be confirmed. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example, “/ab+c/gi”

pattern_description instance-attribute 

pattern_description: NotRequired[DescriptionSafe]

The pattern description for the customer pattern.

pattern_name instance-attribute 

pattern_name: PatternName

The pattern name for the custom pattern.

pattern_regex instance-attribute 

pattern_regex: Regex

The pattern regex for the customer pattern. The format must follow JavaScript regex format. The pattern must be enclosed between slashes, and can have flags behind the second slash. For example: “/ab+c/gi”.