---
name: fastapi
description: FastAPI best practices and conventions. Use when working with FastAPI APIs and Pydantic models for them. Keeps FastAPI code clean and up to date with the latest features and patterns, updated with new versions. Write new code or refactor and update old code.
---

# FastAPI

Official FastAPI skill to write code with best practices, keeping up to date with new versions and features.

## Use the `fastapi` CLI

     * It sets the file pattern to match files starting with "stopwords"
     * and ending with ".txt".
     */
    public StopwordsCreator() {
        super("stopwords.*\\.txt");
    }

    /**
     * Registers this creator with the dictionary manager upon initialization.
     * This method is annotated with {@link PostConstruct} to be executed after
     * dependency injection is complete.
     */

   *
   * <p><b>Warning:</b> If an existing entry with this value is removed, the key for that entry is
   * discarded and not returned.
   *
   * @param key the key with which the specified value is to be associated
   * @param value the value to be associated with the specified key
   * @return the value that was previously associated with the key, or {@code null} if there was no

        assertEquals("s3://my-bucket/", wizardAction.convertCrawlingPath("s3://my-bucket/"));
        assertEquals("s3://bucket.with.dots/path", wizardAction.convertCrawlingPath("s3://bucket.with.dots/path"));
        assertEquals("s3://bucket-with-dashes/path", wizardAction.convertCrawlingPath("s3://bucket-with-dashes/path"));
        assertEquals("s3://123bucket/path", wizardAction.convertCrawlingPath("s3://123bucket/path"));
    }

To enable the integration of custom authentication methods, MinIO can be configured with an Identity Management Plugin webhook. When configured, this plugin enables the `AssumeRoleWithCustomToken` STS API extension. A user or application can now present a token to the `AssumeRoleWithCustomToken` API, and MinIO verifies this token by sending it to the Identity Management Plugin webhook. This plugin responds with some information and MinIO is able to generate temporary STS credentials to interact...

    }

    @Test
    @DisplayName("Test with various file ID patterns")
    void testWithVariousFileIdPatterns() {
        // Test with all zeros
        byte[] zeroFileId = new byte[16];
        Smb2FlushRequest zeroRequest = new Smb2FlushRequest(mockConfig, zeroFileId);
        testFileIdInRequest(zeroRequest, zeroFileId);

        // Test with all ones
        byte[] onesFileId = new byte[16];

    -   Uses `pycpp.sh`, `code_check_changed_files.sh`

These "env" files match up with an environment matrix that roughly covers:

-   Different Python versions
-   Linux, MacOS, and Windows machines (these pool definitions are internal)
-   x86 and arm64
-   CPU-only, or with NVIDIA CUDA support (Linux only), or with TPUs

## How to Test Your Changes to TensorFlow

class NonPydanticModel:
    pass


def test_invalid_response_model_raises():
    with pytest.raises(FastAPIError):
        app = FastAPI()

        @app.get("/", response_model=NonPydanticModel)
        def read_root():
            pass  # pragma: nocover


def test_invalid_response_model_sub_type_raises():
    with pytest.raises(FastAPIError):
        app = FastAPI()

 * This is a system-level exception that indicates problems with data store
 * configuration, connectivity, or data processing.
 */
public class DataStoreException extends FessSystemException {
    private static final long serialVersionUID = 1L;

    /**
     * Creates a new DataStoreException with the specified message and cause.
     *
     * @param message the error message

    session = Session()
    try:
        yield session
    finally:
        session.open = False


def dep_session() -> Any:
    with acquire_session() as s:
        yield s


def broken_dep_session() -> Any:
    with acquire_session() as s:
        s.open = False
        yield s


SessionDep = Annotated[Session, Depends(dep_session)]