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

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

@@ -0,0 +1,188 @@
+"""The `anvil.email` module contains functions for sending and receiving email in your Anvil app.
+
+[Anvil Docs](https://anvil.works/docs/email)"""
+
+from typing import Callable, TypeVar, overload
+
+from anvil import Media
+
+# @server-only
+# TypeVar for email handler functions
+_MessageHandler = TypeVar("_MessageHandler", bound=Callable[["Message"], None])
+# @end-server-only
+
+
+class SendFailure(Exception):
+    """Raised when sending an email fails."""
+    ...
+
+
+class DeliveryFailure(Exception):
+    """While handling an error, you can raise a DeliveryFailure exception to reject email delivery.
+
+    Optionally, you may specify a message and SMTP error code with the rejection.
+
+    [Anvil Docs](https://anvil.works/docs/email/sending_and_receiving#rejecting-email)"""
+
+    def __init__(self, message: str | None = None, smtp_code: int = 554) -> None: ...
+
+
+class Address:
+    """Represents an email address."""
+    address: str
+    """The email address this object represents."""
+    name: str
+    """The name associated with the address this object represents."""
+    raw_value: str
+    """The full string value of this address."""
+
+
+class SendReport:
+    """Report returned after sending an email."""
+    message_id: str
+    """The Message-ID header given to this outgoing message."""
+
+
+class Message:
+    """Represents an incoming email message.
+
+    [Anvil Docs](https://anvil.works/docs/email/incoming)"""
+
+    class Envelope:
+        """The sender and recipient of an email, according to the SMTP envelope."""
+        from_address: str
+        """The email address from which this message was sent, according to the SMTP envelope."""
+        recipient: str
+        """The email address that received this message.
+
+        Note that this email address may not appear in any of the headers (eg if the email has been BCCed or blind forwarded)."""
+
+    class DKIM:
+        """Object describing whether a message was signed by the sending domain."""
+        valid_from_sender: bool
+        """Was this message signed by the domain in its envelope "from" address?"""
+        domains: list[str]
+        """A list of the DKIM domains that signed this message."""
+
+    class Addressees:
+        """The addresses an email was sent from and to, according to the headers."""
+        to_addresses: list[Address]
+        """The addresses this message was sent to."""
+        from_address: Address | None
+        """The address this message was sent from."""
+        cc_addresses: list[Address]
+        """The addresses this message was copied to."""
+
+    envelope: Envelope
+    """The sender and recipient of this email, according to the SMTP envelope."""
+    dkim: DKIM
+    """Object describing whether this message was signed by the sending domain."""
+    addressees: Addressees
+    """The addresses this email was sent from and to, according to the headers."""
+    headers: list[tuple[str, str]]
+    """All the headers in this email, as a list of (name, value) pairs."""
+    text: str | None
+    """The plain-text content of this email, or None if there is no plain-text part."""
+    subject: str | None
+    """The subject of this email, or None if there is no subject."""
+    html: str | None
+    """The HTML content of this email, or None if there is no HTML part."""
+    attachments: list[Media]
+    """A list of this email's attachments."""
+    inline_attachments: dict[str, Media]
+    """A dictionary of this email's inline attachments. Keys are ContentID headers, values are the attachments as Media Objects."""
+
+    def get_header(self, header_name: str, default: str | None = None) -> str | None:
+        """Return the value of the specified header, or default value if it is not present.
+
+        Case-insensitive. If the header is specified multiple times, returns the first value."""
+        ...
+
+    def list_header(self, header_name: str) -> list[str]:
+        """Return a list containing every value of the specified header. Case-insensitive."""
+        ...
+
+    def reply(
+        self,
+        *,
+        to: str | list[str] | None = None,
+        cc: str | list[str] | None = None,
+        bcc: str | list[str] | None = None,
+        from_address: str | None = None,
+        from_name: str | None = None,
+        subject: str | None = None,
+        text: str | None = None,
+        html: str | None = None,
+        attachments: list[Media] | None = None,
+    ) -> SendReport:
+        """Reply to this email."""
+        ...
+
+
+def send(
+    *,
+    to: str | list[str] | None = None,
+    cc: str | list[str] | None = None,
+    bcc: str | list[str] | None = None,
+    from_address: str = "no-reply",
+    from_name: str | None = None,
+    subject: str | None = None,
+    text: str | None = None,
+    html: str | None = None,
+    attachments: list[Media] | None = None,
+    inline_attachments: dict[str, Media] | None = None,
+) -> SendReport:
+    """Send an email.
+
+    Args:
+        to: The email recipient[s] in the 'To' field. Can be a string or list of strings.
+            Each string can be a bare address (eg 'joe@example.com') or include a display name (eg 'Joe Bloggs <joe@example.com>').
+        cc: The email recipient[s] in the 'Cc' field. Can be a string or list of strings.
+        bcc: The email recipient[s] in the 'Bcc' field. Can be a string or list of strings.
+        from_address: The From: address from this email. If no domain is specified, or the specified domain is not a legal sending domain for this app, the address will be replaced with a valid domain.
+        from_name: The name associated with the From: address for this email. (Only valid if the from_address is a bare email address.)
+        subject: The subject line for this email.
+        text: The plain-text (no HTML) content for this email. You must specify at least one of 'text' and 'html'.
+        html: The HTML content for this email. You must specify at least one of 'text' and 'html'.
+        attachments: A list of Media objects to send as attachments with this email.
+        inline_attachments: Inline attachments that can be used in this email's HTML, for example in <img> tags. Must be a dictionary whose keys are IDs and values are Media objects. IDs can then be used in a message's HTML with 'cid:xxx' URIs.
+
+    [Anvil Docs](https://anvil.works/docs/email)"""
+    ...
+
+
+# @server-only
+@overload
+def handle_message(fn: _MessageHandler) -> _MessageHandler:
+    """Decorator to handle incoming emails.
+
+    [Anvil Docs](https://anvil.works/docs/email/incoming)"""
+    ...
+
+
+@overload
+def handle_message(*, require_dkim: bool = False) -> Callable[[_MessageHandler], _MessageHandler]:
+    """Decorator to handle incoming emails.
+
+    Args:
+        require_dkim: If True, reject emails without a valid DKIM signature from the sender.
+
+    [Anvil Docs](https://anvil.works/docs/email/incoming)"""
+    ...
+
+
+def handle_message(
+    fn: _MessageHandler | None = None, require_dkim: bool = False
+) -> _MessageHandler | Callable[[_MessageHandler], _MessageHandler]:
+    """Decorator to handle incoming emails.
+
+    Can be used with or without arguments:
+    - `@anvil.email.handle_message` - handle all incoming emails
+    - `@anvil.email.handle_message(require_dkim=True)` - only handle emails with valid DKIM
+
+    Args:
+        require_dkim: If True, reject emails without a valid DKIM signature from the sender.
+
+    [Anvil Docs](https://anvil.works/docs/email/incoming)"""
+    ...
+# @end-server-only

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

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

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

@@ -0,0 +1,28 @@
+# Type stubs for anvil.facebook.auth module
+# Generated files: client/anvil/facebook/auth.pyi, server/anvil/facebook/auth.pyi
+
+# @client-only
+def login() -> None:
+    """Prompt the user to log in with their Facebook account."""
+    ...
+# @end-client-only
+
+def get_user_email() -> str | None:
+    """Get the email address of the currently-logged-in Facebook user.
+
+    To log in with Facebook, call facebook.auth.login() from form code."""
+    ...
+
+def get_user_id() -> str | None:
+    """Get the Facebook user ID of the currently-logged-in Facebook user.
+
+    To log in with Facebook, call facebook.auth.login() from form code."""
+    ...
+
+def get_user_access_token() -> str | None:
+    """Get the Facebook access token of the currently-logged-in Facebook user.
+
+    To log in with Facebook, call facebook.auth.login() from form code.
+
+    [Anvil Docs](https://anvil.works/docs/integrations/facebook)"""
+    ...

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

@@ -0,0 +1,50 @@
+# @server-only-file
+# Type stubs for anvil.files module
+# Generated files: server/anvil/files.pyi
+
+from typing import IO, Any
+
+class OpenContextManager:
+    """Context manager for opening data files."""
+
+    def __enter__(self) -> IO[Any]:
+        """Open the file."""
+        ...
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+        """Close the file, uploading its contents if it was opened for writing or appending."""
+        ...
+
+class EditingContextManager:
+    """Context manager for editing data files."""
+
+    def __enter__(self) -> str:
+        """Begin editing the file. Returns the path to a temporary file."""
+        ...
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+        """End editing the file, uploading its new contents."""
+        ...
+
+class Files:
+    """Access to Data Files from the Data Files Service.
+
+    To access a file stored in the Data Files Service use square brackets
+    containing the path of the desired file - `data_files['<file_path>']`."""
+
+    def __getitem__(self, path: str) -> str:
+        """Return the path of a file."""
+        ...
+    def editing(self, path: str) -> EditingContextManager:
+        """Edit a file.
+
+        To ensure the proper acquisition and release of the file, use the `editing`
+        function in a `with` statement e.g. `with data_files.editing('test.txt') as file:`"""
+        ...
+    def open(self, path: str, mode: str = "r") -> OpenContextManager:
+        """The open() function opens the file (if possible) and returns the corresponding file object."""
+        ...
+
+data_files: Files
+"""Access Data Files from the Data Files Service.
+
+To access a file stored in the Data Files Service use square brackets
+containing the path of the desired file - `data_files['<file_path>']`."""

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

@@ -0,0 +1,7 @@
+# Type stubs for anvil.google module
+# Generated files: client/anvil/google/__init__.pyi, server/anvil/google/__init__.pyi
+
+from anvil.google import auth as auth
+from anvil.google import drive as drive
+from anvil.google import mail as mail
+from anvil.google import sheets as sheets

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

@@ -0,0 +1,35 @@
+# Type stubs for anvil.google.auth module
+# Generated files: client/anvil/google/auth.pyi, server/anvil/google/auth.pyi
+
+# @client-only
+def login(additional_scopes: list[str] | None = None) -> None:
+    """Prompt the user to log in with their Google account.
+
+    If you have specified your own client ID in the Google Service configuration,
+    you can specify additional OAuth scopes for use with the Google REST API."""
+    ...
+# @end-client-only
+
+def get_user_email() -> str | None:
+    """Get the email address of the currently-logged-in Google user.
+
+    To log in with Google, call anvil.google.auth.login() from form code."""
+    ...
+
+def get_user_access_token() -> str | None:
+    """Get the secret access token of the currently-logged-in Google user, for use with the Google REST API.
+
+    Requires this app to have its own Google client ID and secret."""
+    ...
+
+def get_user_refresh_token() -> str | None:
+    """Get the secret refresh token of the currently-logged-in Google user, for use with the Google REST API.
+
+    Requires this app to have its own Google 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 Google REST API.
+
+    Requires this app to have its own Google client ID and secret."""
+    ...

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

@@ -0,0 +1,94 @@
+# 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/source/anvil/google/mail.pyi

@@ -0,0 +1,21 @@
+# @server-only-file
+# 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/source/anvil/google/sheets.pyi

@@ -0,0 +1,94 @@
+# 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/source/anvil/http.pyi

@@ -0,0 +1,62 @@
+# 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/source/anvil/image.pyi

@@ -0,0 +1,26 @@
+# 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."""
+    ...