Meta: Tracking issue for dropping Starlette

[provinzkraut]

Tracking issue for the current progress of dropping starlette dependencies

How to use?

The following list can serve as an entry-point when tackling the remove of a specific starlette dependencies. It lists the names imported from starlette by their source module and all files that import it.

It is autogenerated with the ast module, and will be updated accordingly.

Overview

• starlette.status (Enhancement: Replace Starlette Responses #626)

  Names

  • HTTP_400_BAD_REQUEST

    References

    • examples/application_hooks/after_exception_hook.py
    • starlite/exceptions/http_exceptions.py
    • tests/app/test_error_handling.py
    • tests/dependency_injection/test_http_handler_dependency_injection.py
    • tests/kwargs/test_cookie_params.py
    • tests/kwargs/test_header_params.py
    • tests/kwargs/test_layered_params.py
    • tests/kwargs/test_path_params.py
    • tests/kwargs/test_query_params.py
    • tests/openapi/test_responses.py
    • tests/routing/test_path_resolution.py
    • tests/test_exception_handlers.py
    • tests/test_exceptions.py
    • tests/utils/test_exceptions.py

  • HTTP_200_OK

    References

    • examples/tests/application_hooks/test_application_before_send.py
    • examples/tests/dependency_injection/test_dependency_default_value_no_dependency_fn.py
    • examples/tests/dependency_injection/test_dependency_default_value_with_dependency_fn.py
    • examples/tests/dependency_injection/test_dependency_skip_validation.py
    • examples/tests/middleware/test_session_middleware.py
    • examples/tests/test_hello_world.py
    • examples/tests/test_using_application_state.py
    • starlite/handlers/http.py
    • starlite/openapi/controller.py
    • tests/app/test_before_send.py
    • tests/connection/request/test_starlette_tests.py
    • tests/datastructures/test_background_task.py
    • tests/dependency_injection/test_http_handler_dependency_injection.py
    • tests/dependency_injection/test_injection_of_generic_models.py
    • tests/dependency_injection/test_inter_dependencies.py
    • tests/dto_factory/test_dto_factory_integration.py
    • tests/handlers/asgi/test_handle_asgi.py
    • tests/handlers/http/test_defaults.py
    • tests/handlers/http/test_kwarg_handling.py
    • tests/handlers/http/test_to_response.py
    • tests/handlers/http/test_validations.py
    • tests/kwargs/test_cookie_params.py
    • tests/kwargs/test_defaults.py
    • tests/kwargs/test_header_params.py
    • tests/kwargs/test_layered_params.py
    • tests/kwargs/test_path_params.py
    • tests/kwargs/test_query_params.py
    • tests/kwargs/test_reserved_kwargs_injection.py
    • tests/life_cycle_hooks/test_after_response.py
    • tests/logging_config/test_logging_config.py
    • tests/middleware/test_authentication.py
    • tests/middleware/test_csrf.py
    • tests/middleware/test_logging.py
    • tests/middleware/test_rate_limit.py
    • tests/openapi/test_controller.py
    • tests/openapi/test_integration.py
    • tests/openapi/test_responses.py
    • tests/plugins/piccolo_orm/test_piccolo_orm_plugin_integration.py
    • tests/plugins/sql_alchemy_plugin/test_sql_alchemy_config.py
    • tests/plugins/sql_alchemy_plugin/test_sql_alchemy_plugin_integration.py
    • tests/plugins/tortoise_orm/test_tortoise_orm_plugin_integration.py
    • tests/response/test_error_handling.py
    • tests/response/test_serialization.py
    • tests/routing/test_path_resolution.py
    • tests/test_controller.py
    • tests/test_dependency.py
    • tests/test_guards.py
    • tests/utils/test_extractors.py

  • HTTP_201_CREATED

    References

    • examples/tests/middleware/test_session_middleware.py
    • starlite/handlers/http.py
    • tests/dto_factory/test_dto_factory_integration.py
    • tests/handlers/http/test_defaults.py
    • tests/handlers/http/test_kwarg_handling.py
    • tests/kwargs/test_json_data.py
    • tests/kwargs/test_multipart_data.py
    • tests/kwargs/test_reserved_kwargs_injection.py
    • tests/kwargs/test_url_encoded_data.py
    • tests/middleware/session/test_middleware.py
    • tests/middleware/test_csrf.py
    • tests/middleware/test_session_middleware.py
    • tests/plugins/piccolo_orm/test_piccolo_orm_plugin_integration.py
    • tests/plugins/sql_alchemy_plugin/test_sql_alchemy_plugin_integration.py
    • tests/plugins/tortoise_orm/test_tortoise_orm_plugin_integration.py
    • tests/response/test_response_headers.py
    • tests/test_controller.py

  • HTTP_204_NO_CONTENT

    • examples/tests/middleware/test_session_middleware.py
    • starlite/handlers/http.py
    • starlite/response.py
    • tests/handlers/http/test_defaults.py
    • tests/handlers/http/test_kwarg_handling.py
    • tests/kwargs/test_reserved_kwargs_injection.py
    • tests/routing/test_path_resolution.py
    • tests/test_controller.py
    • tests/test_signature.py

  • HTTP_500_INTERNAL_SERVER_ERROR

    References

    • examples/tests/dependency_injection/test_dependency_validation_error.py
    • starlite/exceptions/http_exceptions.py
    • starlite/middleware/exceptions.py
    • starlite/utils/exception.py
    • tests/app/test_error_handling.py
    • tests/middleware/session/test_middleware.py
    • tests/middleware/test_authentication.py
    • tests/middleware/test_exception_handler_middleware.py
    • tests/middleware/test_session_middleware.py
    • tests/test_dependency.py
    • tests/test_exceptions.py
    • tests/utils/test_exceptions.py

  • HTTP_304_NOT_MODIFIED

    • starlite/handlers/http.py
    • starlite/response.py
    • tests/handlers/http/test_validations.py

  • WS_1000_NORMAL_CLOSURE

    • starlite/connection/websocket.py

  • HTTP_404_NOT_FOUND

    • starlite/exceptions/http_exceptions.py
    • starlite/openapi/controller.py
    • tests/openapi/test_controller.py
    • tests/openapi/test_integration.py
    • tests/routing/test_path_resolution.py

  • HTTP_401_UNAUTHORIZED

    • starlite/exceptions/http_exceptions.py

  • HTTP_403_FORBIDDEN

    • starlite/exceptions/http_exceptions.py
    • tests/middleware/test_authentication.py
    • tests/test_guards.py

  • HTTP_405_METHOD_NOT_ALLOWED

    • starlite/exceptions/http_exceptions.py
    • tests/routing/test_path_resolution.py

  • HTTP_429_TOO_MANY_REQUESTS

    • starlite/exceptions/http_exceptions.py
    • tests/middleware/test_rate_limit.py

  • HTTP_503_SERVICE_UNAVAILABLE

    • starlite/exceptions/http_exceptions.py

  • HTTP_100_CONTINUE

    • tests/handlers/http/test_validations.py

  • HTTP_307_TEMPORARY_REDIRECT

    • tests/handlers/http/test_validations.py
    • tests/openapi/test_responses.py

  • HTTP_308_PERMANENT_REDIRECT

    • tests/handlers/http/test_to_response.py

  • HTTP_406_NOT_ACCEPTABLE

    • tests/openapi/test_responses.py

• starlette.datastructures

  Names

  • MutableHeaders (Replace starlettes Headers and MutableHeaders, move FormMultiDict to multidict #732)

    References

    • examples/application_hooks/before_send_hook.py
    • examples/middleware/base.py
    • starlite/middleware/compression/brotli.py
    • starlite/middleware/csrf.py
    • starlite/middleware/rate_limit.py
    • starlite/middleware/session.py
    • starlite/middleware/session/base.py
    • starlite/middleware/session/cookie_backend.py
    • starlite/testing/test_client/client.py
    • tests/app/test_before_send.py
    • tests/middleware/test_base_middleware.py

  • URL (Replace starlette URL, URLPath and Address #738)

    • starlite/connection/base.py
    • starlite/kwargs.py
    • starlite/middleware/allowed_hosts.py
    • starlite/signature.py
    • tests/test_signature.py

  • Headers (Replace starlettes Headers and MutableHeaders, move FormMultiDict to multidict #732)

    • starlite/connection/base.py
    • starlite/connection/websocket.py
    • starlite/middleware/compression/brotli.py
    • tests/connection/websocket/test_websocket.py
    • tests/middleware/test_compression_middleware.py

  • Address (Replace starlette URL, URLPath and Address #738)

    • starlite/connection/base.py
    • tests/connection/request/test_request.py
    • tests/connection/request/test_starlette_tests.py

  • URLPath (Replace starlette URL, URLPath and Address #738)

    • starlite/connection/base.py

  • ImmutableMultiDict (Replace starlettes Headers and MutableHeaders, move FormMultiDict to multidict #732)

    • starlite/datastructures/form_multi_dict.py

  • State

    • tests/connection/request/test_starlette_tests.py

• starlette.middleware.Middleware (Enhancment: Replace starlette's Middleware with our own implementation #674)

  • starlite/app.py
  • starlite/asgi/routing_trie/mapping.py
  • starlite/types/composite.py
  • tests/middleware/test_middleware_handling.py

• starlette.middleware.cors.CORSMiddleware (Enhancment: Replace starlette's CORSMiddleware with our own implementation #669)

  • starlite/app.py
  • tests/middleware/test_middleware_handling.py

• starlette.middleware.trustedhost.TrustedHostMiddleware (Enhancment: Replace starlette's TrustedHostMiddleware with our own implementation #670)

  • starlite/app.py
  • tests/middleware/test_middleware_handling.py

• starlette.staticfiles.StaticFiles ( Enhancment: Replace starlette's StaticFiles with our own implementation #671)

  • starlite/app.py
  • starlite/config/static_files.py

• starlette.responses (Enhancement: Replace Starlette Responses #626)

  Names

  • Response
    • starlite/datastructures/response_containers.py
    • starlite/handlers/http.py
    • starlite/middleware/exceptions.py
    • starlite/response.py
    • starlite/routes/http.py
    • starlite/types/callable_types.py
    • tests/handlers/http/test_to_response.py
  • RedirectResponse
    • starlite/datastructures/response_containers.py
    • starlite/routes/http.py
    • tests/handlers/http/test_to_response.py
  • FileResponse
    • starlite/datastructures/response_containers.py
    • tests/handlers/http/test_to_response.py
  • StreamingResponse
    • starlite/datastructures/response_containers.py
    • tests/handlers/http/test_to_response.py
  • PlainTextResponse
    • tests/handlers/http/test_to_response.py
    • tests/middleware/test_compression_middleware.py
  • HTMLResponse
    • tests/handlers/http/test_to_response.py
  • JSONResponse
    • examples/routing/mounting_starlette_app.py
    • tests/compatibility/test_starlette_responses.py
    • tests/handlers/http/test_to_response.py

• starlette.routing

  • Router (Update ASGI router #644)
    • starlite/asgi.py
  • get_name (Replace get name #646)
    • starlite/openapi/path_item.py
    • starlite/openapi/responses.py
    • starlite/routes/asgi.py
    • starlite/routes/http.py
    • starlite/routes/websocket.py
  • Route
    • examples/routing/mounting_starlette_app.py

• starlette.exceptions.HTTPException

  • starlite/exceptions/http_exceptions.py
  • starlite/middleware/exceptions.py
  • starlite/utils/exception.py
  • tests/middleware/test_exception_handler_middleware.py
  • tests/test_exceptions.py

• starlette.middleware.errors.ServerErrorMiddleware (Enhancment: Replace starlette's ServerErrorMiddleware with our own implementation #672)

  • starlite/middleware/exceptions.py

• starlette.middleware.gzip (Enhancment: Replace starlette's GZipMiddleware and GZipResponder with our own implementation #673)

  • GZipMiddleware
    • starlite/middleware/compression/gzip.py
  • GZipResponder
    • starlite/middleware/compression/brotli.py

• starlette.middleware.base

  • BaseHTTPMiddleware (Enhancement: Replace BaseHTTPMiddleware with a starlite implementation #642)
    • starlite/types/composite.py
    • tests/middleware/test_middleware_handling.py
  • RequestResponseEndpoint
    • tests/middleware/test_middleware_handling.py

• starlette.requests

  • cookie_parser (added cookie parser #645)
    • starlite/connection/base.py
    • starlite/utils/extractors.py
  • SERVER_PUSH_HEADERS_TO_COPY
    • starlite/connection/request.py
  • Request
    • examples/routing/mounting_starlette_app.py

• starlette.testclient.TestClient (Replace Test Client #664)

  • starlite/testing/test_client.py
  • tests/connection/request/test_starlette_tests.py
  • tests/connection/websocket/test_starlette_tests.py

• starlette.background (Replace background tasks #652)

  • BackgroundTask
    • starlite/datastructures/background_tasks.py
  • BackgroundTasks
    • starlite/datastructures/background_tasks.py

• starlette.websockets.WebSocketDisconnect

  • tests/connection/websocket/test_starlette_tests.py
  • tests/connection/websocket/test_websocket.py
  • tests/dependency_injection/test_websocket_handler_dependency_injection.py
  • tests/middleware/test_authentication.py
  • tests/test_guards.py

• starlette.status

  • tests/connection/websocket/test_starlette_tests.py
  • tests/middleware/test_csrf.py

• starlette.applications.Starlette

  • examples/routing/mounting_starlette_app.py

[Goldziher]

nice!

So checkout my draft PR - I am tackling some of these there, primarily the response types and status

[provinzkraut]

@Goldziher Have that on my radar already! I haven't viewed your PR in detail yet. Does it fully remove all references to the status codes and responses?

[Goldziher]

@Goldziher Have that on my radar already! I haven't viewed your PR in detail yet. Does it fully remove all references to the status codes and responses?

Yes, it will.

[provinzkraut]

I added a reference to the pending PR, so it's visible that it's WIP. Once that's merged tasks will be updated!

[Goldziher]

The remaining items for starlette.exceptions.HTTPException and starlette.responses are all tests.
I would like to keep these - we should make sure we preserve compatibility. So you can remove them from the list or strike them through or whatever.

[jtraub]

I would like to keep these - we should make sure we preserve compatibility

Wouldn't it be better to copy existing tests involving starlette classes into a separate folder (idk, compatibility) and rewrite source tests to use starlite implementation instead? Starlite implementation should be tested too.

[Goldziher]

I would like to keep these - we should make sure we preserve compatibility

Wouldn't it be better to copy existing tests involving starlette classes into a separate folder (idk, compatibility) and rewrite source tests to use starlite implementation instead? Starlite implementation should be tested too.

It would certainly be cleaner. But the tests are not 1:1 imports of the Starlette tests, they are heavily modified, sometimes compeltely rewritten - the point is to make sure that whatever worked in Starlette also works in our API, but we are not testing Starlette - we are testing only our code.

[provinzkraut]

The remaining items for starlette.exceptions.HTTPException and starlette.responses are all tests. I would like to keep these - we should make sure we preserve compatibility. So you can remove them from the list or strike them through or whatever.

I noticed that as well. Will update the file later!

[Goldziher]

testing client is done.

[Goldziher]

ok, as discussed we will not include BaseMiddleware - we we are only keeping tests for this now. Please remove it from the list @provinzkraut

[Goldziher]

And, we are done