Class Script

tools/Polygraphy/polygraphy/tools/script.py:197–457

Represents a Python script that uses the Polygraphy API.

@mod.export()
class Script:
    """
    Represents a Python script that uses the Polygraphy API.
    """

    class String:
        """
        Represents a string that has passed Polygraphy's security checks.
        """

        def __init__(self, s, safe=False, inline=False):
            self.s = s
            self.safe = safe
            self.inline = inline

        def __str__(self):
            return str(self.s)

        def __repr__(self):
            if self.inline:
                # Since only safe strings can be marked inline, self.safe is always
                # True in this branch, so no need to check it.
                return str(self.s)
            return repr(self.s)

        def __iadd__(self, other):
            if not isinstance(other, Script.String):
                G_LOGGER.internal_error(f"Cannot concatenate str and Script.String. Note: str was: {other}")
            elif self.safe != other.safe:
                G_LOGGER.internal_error(f"Cannot concatenate unsafe string ({other}) to safe string ({self.s})!")
            self.s += other.s
            return self

        def __eq__(self, other):
            return (
                isinstance(other, Script.String)
                and self.safe == other.safe
                and self.inline == other.inline
                and self.s == other.s
            )

        def __hash__(self):
            return hash((self.s, self.safe, self.inline))

        def unwrap(self):
            """
            Returns the underlying string object.

            Returns:
                str
            """
            return self.s

    DATA_LOADER_NAME = String("data_loader", safe=True, inline=True)

    def __init__(self, summary=None, always_create_runners=True):
        """
        Args: