@anvil-works/anvil-pyright 0.0.1 → 0.0.2-canary

package/dist/anvil-typeshed/source/anvil/media.pyi

@@ -0,0 +1,62 @@
+# Type stubs for anvil.media module
+# Generated files: client/anvil/media.pyi, server/anvil/media.pyi
+
+from typing import IO, Any
+
+from anvil import Media
+
+# @client-only
+def print_media(media: Media, /) -> None:
+    """Print the given Media Object immediately in the user's browser."""
+    ...
+
+def download(media: Media, /) -> None:
+    """Download the given Media Object immediately in the user's browser."""
+    ...
+
+class TempUrl:
+    """Creates a temporary client-side URL for a Media object, even if the media has no permanent URL.
+
+    This URL should be revoked when you are finished with it. If you use TempUrl as a context
+    manager ('with TempUrl(media) as url:'), this happens automatically; if you instantiate it
+    manually you must call 'revoke()' on the instance.
+
+    The download argument only affects LazyMedia objects."""
+
+    url: str
+    """The temporary URL."""
+
+    def __init__(self, media: Media, *, download: bool = True) -> None: ...
+    def __enter__(self) -> str:
+        """Get the url using a 'with' block."""
+        ...
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+        """Revoke a url when exiting a 'with' block."""
+        ...
+    def revoke(self) -> None:
+        """Revoke a url from a media object."""
+        ...
+# @end-client-only
+
+# @server-only
+class TempFile:
+    """Create a temporary file initialised with the contents of the provided media, if any."""
+
+    def __init__(self, media: Media | None = None) -> None: ...
+    def __enter__(self) -> str:
+        """Returns the path to the temporary file."""
+        ...
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None: ...
+
+def from_file(filename: str, mime_type: str | None = None, name: str | None = None) -> Media:
+    """Creates a Media object from the given file."""
+    ...
+
+def open(media: Media) -> IO[bytes]:
+    """Open a media file as Python BytesIO object."""
+    ...
+# @end-server-only
+
+def write_to_file(media: Media, filename: str) -> None:
+    """Write a Media object to the given file."""
+    ...

package/dist/anvil-typeshed/source/anvil/microsoft/__init__.pyi

@@ -0,0 +1,4 @@
+# Type stubs for anvil.microsoft module
+# Generated files: client/anvil/microsoft/__init__.pyi, server/anvil/microsoft/__init__.pyi
+
+from anvil.microsoft import auth as auth

package/dist/anvil-typeshed/source/anvil/microsoft/auth.pyi

@@ -0,0 +1,32 @@
+# Type stubs for anvil.microsoft.auth module
+# Generated files: client/anvil/microsoft/auth.pyi, server/anvil/microsoft/auth.pyi
+
+# @client-only
+def login() -> None:
+    """Prompt the user to log in with their Microsoft account."""
+    ...
+# @end-client-only
+
+def get_user_email() -> str | None:
+    """Get the email address of the currently-logged-in Microsoft user.
+
+    To log in with Microsoft, call anvil_microsoft.auth.login() from form code."""
+    ...
+
+def get_user_access_token() -> str | None:
+    """Get the secret access token of the currently-logged-in Microsoft user, for use with the Microsoft REST API.
+
+    Requires this app to have its own Microsoft client ID and secret."""
+    ...
+
+def get_user_refresh_token() -> str | None:
+    """Get the secret refresh token of the currently-logged-in Microsoft user, for use with the Microsoft REST API.
+
+    Requires this app to have its own Microsoft client ID and secret."""
+    ...
+
+def refresh_access_token(refresh_token: str, /) -> str:
+    """Get a new access token from a refresh token you have saved, for use with the Microsoft REST API.
+
+    Requires this app to have its own Microsoft client ID and secret."""
+    ...

package/dist/anvil-typeshed/source/anvil/mpl_util.pyi

@@ -0,0 +1,25 @@
+# Type stubs for anvil.mpl_util module
+# Generated files: client/anvil/mpl_util.pyi, server/anvil/mpl_util.pyi
+
+from typing import Any
+
+from anvil import Media
+
+def plot_image(
+    *,
+    dpi: int | None = None,
+    facecolor: Any | None = None,
+    edgecolor: Any | None = None,
+    format: str | None = None,
+    transparent: bool | None = None,
+    frameon: bool | None = None,
+    bbox_inches: str | Any | None = None,
+    pad_inches: float | None = None,
+    filename: str | None = None,
+) -> Media:
+    """Return the current Matplotlib figure as a PNG image.
+
+    Returns an Anvil Media object that can be displayed in Image components.
+
+    Optional arguments have the same meaning as for 'savefig()'."""
+    ...

package/dist/anvil-typeshed/source/anvil/pdf.pyi

@@ -0,0 +1,58 @@
+# @server-only-file
+# Type stubs for anvil.pdf module
+# Generated files: server/anvil/pdf.pyi
+
+from typing import Any, Literal
+
+from anvil import Media
+
+class PDFRenderer:
+    """Configure options for PDF rendering. Returns an object with a render_form() method.
+
+    [Anvil Docs](https://anvil.works/docs/media/creating_pdfs)"""
+
+    def __init__(
+        self,
+        *,
+        filename: str = "print.pdf",
+        landscape: bool = False,
+        margins: dict[str, float] | float | None = None,
+        page_size: str | tuple[float, float] = "letter",
+        quality: Literal["original", "screen", "printer", "prepress", "default"] = "default",
+        scale: float = 1.0,
+    ) -> None:
+        """Create a PDF renderer with specified options.
+
+        Args:
+            filename: The name of the generated PDF file.
+            landscape: Generate a PDF in landscape orientation.
+            margins: Page margins (in centimetres), as a dictionary specifying margins on each side
+                (eg {'top': 1.0, 'bottom': 1.0, 'left': 1.0, 'right': 1.0}) or as a number specifying
+                a global margin. The default value is 1.0.
+            page_size: Can be the name of a standard page size ('letter' or 'A0'-'A10'),
+                or a tuple of (width, height) in centimetres.
+            quality: The quality of the generated PDF, which has a large impact on file size.
+                Available values are: 'original', 'screen', 'printer', 'prepress', 'default'.
+            scale: The scale (zoom level) at which you are printing. The default value is 1.0.
+        """
+        ...
+
+    def render_form(self, form_name: str, *args: Any, **kwargs: Any) -> Media:
+        """Render an Anvil form to PDF.
+
+        Pass the name of the form you want to render, plus any arguments you want
+        to pass to its constructor.
+
+        Returns a PDF as an Anvil Media object."""
+        ...
+
+def render_form(form_name: str, *args: Any, **kwargs: Any) -> Media:
+    """Render an Anvil form to PDF.
+
+    Pass the name of the form you want to render, plus any arguments you want
+    to pass to its constructor.
+
+    Returns a PDF as an Anvil Media object.
+
+    [Anvil Docs](https://anvil.works/docs/working-with-files/creating-pdf-files)"""
+    ...

package/dist/anvil-typeshed/source/anvil/plotly_templates.pyi

@@ -0,0 +1,11 @@
+# Type stubs for anvil.plotly_templates module
+# Generated files: client/anvil/plotly_templates.pyi, server/anvil/plotly_templates.pyi
+
+from typing import Any
+
+templates: dict[str, Any]
+"""A dictionary of custom templates for anvil themes."""
+
+def set_default(template: str | Any) -> None:
+    """Sets the default plotly template."""
+    ...

package/dist/anvil-typeshed/source/anvil/saml/__init__.pyi

@@ -0,0 +1,4 @@
+# Type stubs for anvil.saml module
+# Generated files: client/anvil/saml/__init__.pyi, server/anvil/saml/__init__.pyi
+
+from anvil.saml import auth as auth

package/dist/anvil-typeshed/source/anvil/saml/auth.pyi

@@ -0,0 +1,22 @@
+# Type stubs for anvil.saml.auth module
+# Generated files: client/anvil/saml/auth.pyi, server/anvil/saml/auth.pyi
+
+from typing import Any
+
+# @client-only
+def login() -> None:
+    """Prompt the user to log in via SAML."""
+    ...
+# @end-client-only
+
+def get_user_email() -> str | None:
+    """Get the email address of the currently-logged-in SAML user.
+
+    To log in with SAML, call anvil.saml.auth.login() from form code."""
+    ...
+
+def get_user_attributes() -> dict[str, Any] | None:
+    """Get the user attributes of the currently-logged-in SAML user.
+
+    The exact attributes available will depend on your SAML Identity Provider."""
+    ...

package/dist/anvil-typeshed/source/anvil/secrets.pyi

@@ -0,0 +1,18 @@
+# Type stubs for anvil.secrets module
+# Generated files: client/anvil/secrets.pyi, server/anvil/secrets.pyi
+
+class SecretError(Exception):
+    """Secret access or encryption error."""
+    ...
+
+def get_secret(secret_name: str) -> str:
+    """Retrieve the named secret."""
+    ...
+
+def encrypt_with_key(key_name: str, value: str) -> str:
+    """Encrypt a string with a cryptographic key derived from the named secret."""
+    ...
+
+def decrypt_with_key(key_name: str, value: str) -> str:
+    """Decrypt a string with a cryptographic key derived from the named secret."""
+    ...