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

package/dist/anvil-typeshed/server/anvil/google/drive.pyi

@@ -0,0 +1,98 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.google.drive module
+# Generated files: client/anvil/google/drive.pyi, server/anvil/google/drive.pyi
+
+from typing import Iterator
+
+from anvil import Media
+
+class DriveItem:
+    """Base class for Google Drive items (files and folders)."""
+
+    id: str
+    """ID of the DriveItem."""
+
+    def move(self, dest_folder: "Folder", /) -> None:
+        """Move the DriveItem from one folder to another."""
+        ...
+    def trash(self) -> None:
+        """Move the DriveItem to the trash folder."""
+        ...
+    def delete(self) -> None:
+        """Delete the DriveItem (this cannot be undone)."""
+        ...
+
+class File(DriveItem, Media):
+    """A Google Drive file."""
+
+    def get_bytes(self) -> bytes:
+        """Get the contents of an object representing a Google Drive file.
+
+        Native Google files such as Docs, Slides and Sheets must first be exported
+        to an appropriate file type. All other file types support get_bytes()."""
+        ...
+    def set_bytes(self, content: bytes, /) -> None:
+        """Set the contents of an object representing a Google Drive file."""
+        ...
+    def set_media(self, media: Media, /) -> None:
+        """Upload new contents to an existing File.
+
+        Media must be a Media object."""
+        ...
+
+class Folder(DriveItem):
+    """A Google Drive folder.
+
+    [Anvil Docs](https://anvil.works/docs/integrations/google/google-drive#folders)"""
+
+    folders: list["Folder"]
+    """List of Folder items in the Folder."""
+
+    files: list[File]
+    """List of File items in the Folder."""
+
+    def list_files(self) -> Iterator[File]:
+        """List the files (not folders) in the Folder."""
+        ...
+    def list_folders(self) -> Iterator["Folder"]:
+        """List the folders (not files) in the Folder."""
+        ...
+    def get(self, title: str, /) -> File | None:
+        """Get the File item by title.
+
+        The title argument should be a string."""
+        ...
+    def get_by_id(self, id: str, /) -> File | None:
+        """Get the File item by ID.
+
+        The ID argument should be a string."""
+        ...
+    def create_folder(self, title: str, /) -> "Folder":
+        """Create a new folder within the Folder."""
+        ...
+    def create_file(
+        self,
+        title: str,
+        *,
+        content_bytes: bytes | None = None,
+        content_type: str = "text/plain",
+    ) -> File:
+        """Create a new file within the Folder."""
+        ...
+
+def login(*, extra_scopes: list[str] | None = None) -> None:
+    """Prompt the user to log in to their Google account and ask permission to access their Google Drive files.
+
+    [Anvil Docs](https://anvil.works/docs/integrations/google/google-drive#user-files)"""
+    ...
+
+def get_user_files() -> Folder:
+    """Return the top-level folder containing all the files in the Users drive.
+
+    anvil.google.drive.login() must be called first.
+
+    [Anvil Docs](https://anvil.works/docs/integrations/google/google-drive#user-files)"""
+    ...

package/dist/anvil-typeshed/server/anvil/google/mail.pyi

@@ -0,0 +1,24 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.google.mail module
+# Generated files: server/anvil/google/mail.pyi
+
+def send(
+    *,
+    to: str | list[str] | None = None,
+    subject: str | None = None,
+    text: str | None = None,
+    html: str | None = None,
+    cc: str | list[str] | None = None,
+    bcc: str | list[str] | None = None,
+    from_address: str | None = None,
+    draft: bool = False,
+) -> None:
+    """Send an email via GMail.
+
+    'to', 'cc' and 'bcc' may be strings (email addresses) or lists of strings (multiple addresses).
+    At least one of 'text' and 'html' need to be provided (both strings).
+    Passing draft=True will create a draft message rather than sending it."""
+    ...

package/dist/anvil-typeshed/server/anvil/google/sheets.pyi

@@ -0,0 +1,98 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.google.sheets module
+# Generated files: client/anvil/google/sheets.pyi, server/anvil/google/sheets.pyi
+
+from typing import Any, Iterator
+
+class Cell:
+    """A cell in a Google Sheets worksheet."""
+
+    row: int
+    """This cell's row index (starting from 1)."""
+
+    col: int
+    """This cell's column index (starting from 1)."""
+
+    value: str
+    """The value in this cell."""
+
+    input_value: str
+    """The value that was entered into the cell."""
+
+class Row:
+    """A row in a Google Sheets worksheet."""
+
+    def __getattr__(self, name: str) -> Any: ...
+    def __setattr__(self, name: str, value: Any) -> None: ...
+    def delete(self) -> None:
+        """Delete this row from the worksheet.
+
+        This will cause data in subsequent rows to shift up."""
+        ...
+
+class Worksheet:
+    """A worksheet (tab) in a Google Sheets spreadsheet."""
+
+    title: str
+    """The title of this worksheet."""
+
+    row_count: int
+    """The number of rows in this worksheet."""
+
+    column_count: int
+    """The number of columns in this worksheet."""
+
+    fields: list[str]
+    """The fields in this worksheet (ie the column headers, or the values in the first row)."""
+
+    rows: list[Row]
+    """The rows in this worksheet (excluding the header)."""
+
+    cells: list[Cell]
+    """A list of all the cells in this worksheet."""
+
+    def list_rows(self, **query: Any) -> list[Row]:
+        """List rows in this worksheet.
+
+        Optionally restricting to rows with the specified column values
+        specified as keyword arguments."""
+        ...
+    def add_row(self, **fields: Any) -> Row:
+        """Add a row to the end of the worksheet.
+
+        Specifying values for columns as keywords arguments."""
+        ...
+    def list_cells(
+        self,
+        *,
+        min_row: int | None = None,
+        max_row: int | None = None,
+        min_col: int | None = None,
+        max_col: int | None = None,
+    ) -> list[Cell]:
+        """List cells in the worksheet, optionally specifying a region."""
+        ...
+    def get_cell(self, row: int, col: int) -> Cell:
+        """Get a particular cell from the spreadsheet."""
+        ...
+    def __iter__(self) -> Iterator[Cell]: ...
+
+class Spreadsheet:
+    """A Google Sheets spreadsheet."""
+
+    title: str
+    """The title of this spreadsheet."""
+
+    id: str
+    """The ID of this spreadsheet in Google Drive."""
+
+    worksheets: list[Worksheet]
+    """The worksheets in this spreadsheet."""
+
+    def list_worksheets(self) -> list[Worksheet]:
+        """Get a list of all worksheets in this spreadsheet."""
+        ...
+    def __iter__(self) -> Iterator[Worksheet]: ...

package/dist/anvil-typeshed/server/anvil/http.pyi

@@ -0,0 +1,66 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.http module
+# Generated files: client/anvil/http.pyi, server/anvil/http.pyi
+
+from typing import Any
+
+from anvil import Media
+
+class HttpError(Exception):
+    """HTTP error with status code and content.
+
+    [Anvil Docs](https://anvil.works/docs/http-apis/making-http-requests)"""
+
+    status: int
+    """The numeric HTTP status error (eg 404 for "not found").
+
+    Status will be 0 for errors that prevent the request completing at all
+    (eg cross-origin policy in the browser)."""
+
+    content: Media
+    """The content returned by the request (eg the body of a 404 response)."""
+
+class UrlEncodingError(Exception):
+    """URL encoding/decoding error."""
+    ...
+
+def request(
+    url: str,
+    *,
+    method: str = "GET",
+    data: Any = None,
+    json: bool = False,
+    headers: dict[str, str] | None = None,
+    username: str | None = None,
+    password: str | None = None,
+    timeout: int | float | None = None,
+) -> Media | Any:
+    """Make an HTTP request to the specified URL.
+
+    Args:
+        url: The request will be made to this URL.
+        method: The HTTP method. Defaults to 'GET'.
+        data: The data to send in the request body.
+        json: If set to True, the response is parsed into Python objects (dicts/lists/etc),
+            and 'data' is JSON-encoded before sending. If False, the response will be a Media object.
+        headers: A dict of strings to set HTTP headers.
+        username: If specified, used to perform HTTP Basic authentication.
+        password: If specified, used to perform HTTP Basic authentication.
+        timeout: An int or float representing the amount of time, in seconds, to wait for a response.
+            Default is 60 seconds.
+
+    [Anvil Docs](https://anvil.works/docs/http-apis/making-http-requests)"""
+    ...
+
+def url_encode(string_to_encode: str, /) -> str:
+    """URL-encode a string."""
+    ...
+
+def url_decode(string_to_decode: str, /) -> str:
+    """URL-decode a string.
+
+    Raises UrlEncodingError on failure."""
+    ...

package/dist/anvil-typeshed/server/anvil/image.pyi

@@ -0,0 +1,30 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.image module
+# Generated files: client/anvil/image.pyi, server/anvil/image.pyi
+
+from anvil import Media
+
+class ImageException(Exception):
+    """Image processing exception."""
+    ...
+
+def get_dimensions(image_media: Media, /) -> tuple[int, int]:
+    """Get the dimensions of an image (width, height).
+
+    Pass in an anvil.Media object representing the image."""
+    ...
+
+def generate_thumbnail(image_media: Media, max_size: int, /) -> Media:
+    """Resize the supplied image so that neither width nor height exceeds max_size (in pixels).
+
+    Pass in an anvil.Media object representing the image."""
+    ...
+
+def rotate(image_media: Media, angle: float, /) -> Media:
+    """Rotate the supplied image clockwise by the given number of degrees.
+
+    Pass in an anvil.Media object representing the image."""
+    ...

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

@@ -0,0 +1,32 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# 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
+
+
+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."""
+    ...
+
+def write_to_file(media: Media, filename: str) -> None:
+    """Write a Media object to the given file."""
+    ...

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

@@ -0,0 +1,8 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# 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/server/anvil/microsoft/auth.pyi

@@ -0,0 +1,31 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.microsoft.auth module
+# Generated files: client/anvil/microsoft/auth.pyi, server/anvil/microsoft/auth.pyi
+
+
+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/server/anvil/mpl_util.pyi

@@ -0,0 +1,29 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# 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/server/anvil/pdf.pyi

@@ -0,0 +1,61 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# 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/server/anvil/plotly_templates.pyi

@@ -0,0 +1,15 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# 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/server/anvil/saml/__init__.pyi

@@ -0,0 +1,8 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# 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/server/anvil/saml/auth.pyi

@@ -0,0 +1,21 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# Type stubs for anvil.saml.auth module
+# Generated files: client/anvil/saml/auth.pyi, server/anvil/saml/auth.pyi
+
+from typing import Any
+
+
+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/server/anvil/secrets.pyi

@@ -0,0 +1,22 @@
+# AUTO-GENERATED FILE - DO NOT EDIT
+# Edit the source file in anvil-typeshed/source/ instead, then run:
+#   npm run generate-anvil-stubs
+#
+# 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."""
+    ...