book

Python Web Development with Sanic

by Stephen Sadowski, Adam Hopkins

March 2022

Intermediate to advanced

504 pages

10h 58m

English

Packt Publishing

Read now

Unlock full access

ContributorsAbout the authorAbout the reviewers
Who this book is forWhat this book coversTo get the most out of this bookDownload the example code filesDownload the color imagesConventions usedGet in touchShare Your Thoughts
Technical requirementsWhat is Sanic?Leveling upFramework versus serverWeb serverWeb frameworkWhy we use Sanic—build fast, run fastSimple and lightweightUnopinionated and flexiblePerformant and scalableProduction-readyTrusted by millionsCommunity-drivenWhat drives code decisions?Summary
Technical requirementsSetting up an environment and directoryEnvironmentSanic CLIDirectory structureUsing blueprints effectivelyBlueprint registrationBlueprint versioningGrouping blueprintsWiring it all upControlled importsFactory patternAutodiscoveryRunning our applicationSummary
Technical requirementsUnderstanding HTTP methodsUsing HTTP methods on route handlersAdvanced method routingMethod safety and request bodyRESTful API designSimplifying your endpoints with CBVsBlanket support for OPTIONS and HEADPaths, slashes, and why they matterStrict slashesExtracting information from the pathAdvanced path parametersCustom parameter matchingModifying matched parameter valuesAPI versioningShould all of my routes bump versions?Version prefixingVirtual hostsServing static contentServing static content from SanicServing static content with NginxStreaming static contentSummary
Technical requirementsReading cookies and headersHeaders are flexibleAuthentication headersContext headersSanic extracts header data for usHeaders as multi-dictGetting information from cookies (yum!)Reading forms, query arguments, files, JSON, and moreQuery argumentsForms and filesConsuming JSON dataGetting streaming dataValidating dataStep 1—getting started and making a decoratorStep 2—reading the handler signatureStep 3—modelingStep 4—model hydrationStep 5—performing validationsTaking it to the next level with third-party packagesSummary
Technical requirementsExamining the HTTP response structureThe HTTP response statusResponse groupingsA response through exceptionsCustom statusHeadersThe response bodyRendering HTML contentDelivering HTML filesBasic templatingUsing a templating engineSerializing JSON contentChoosing a serializerSerializing custom objectsBest practicesStreaming dataFile streamingServer-sent events for push communicationStarting with the basicsBuilding some SSE objectsWebsockets for two-way communicationSetting response headers and cookiesResponding with a request IDSetting response cookiesSummary
Technical requirementsMaking use of ctxAltering requests and responses with middlewareRequest middlewareResponse middlewareResponding early (or late) with middlewareMiddleware and streaming responsesLeveraging signals for intra-worker communicationSignal definitionsUsing built-in signalsCustom signalsWaiting on eventsMastering HTTP connectionsKeep-Alive within SanicCaching data per connectionHandling exceptions like a proImplementing proper exception handlingBad exception messagesMisusing statusesResponses through raising an exceptionFallback handlingCatching exceptionsBackground task processingAdding tasks to the loopIntegrating with an outside serviceDesigning an in-process task queueSummary

Technical requirementsSetting up an effective CORS policyWhat is the security issue with ineffective CORS?Protecting applications from CSRFSolutions that do not workSolutions that do workSamesite cookiesProtecting your Sanic app with authenticationUsing API keysUnderstanding session-based versus non-session-based authenticationUsing sessionsJSON Web Tokens (JWTs)Summary
Technical requirementsHandling the server life cycleServer listenersConfiguring an applicationWhat is the Sanic configuration object?How can an application's configuration object be accessed?How can the configuration object be set?Some general rules about configurationRunning Sanic locallyHow does running Sanic locally differ from production?Deploying to productionChoosing the right server optionHow to choose a deployment strategy?Securing your application with TLSSetting up TLS in SanicGetting and renewing a certificate from Let's EncryptDeployment examplesPaaSKubernetes (as-a-service)Summary
Technical requirementsImplementing practical real-world exception handlersCatching errors with middlewareCatching errors with signalsCatching the error and responding manuallyModifying ErrorHandlerSetting up a testable applicationGetting started with sanic-testingA more practical test client implementationUsing ReusableClient for testingGaining insight from logging and tracingTypes of Sanic loggersCreating your own loggers, my first step in application developmentConfiguring loggingAdding color contextAdding some basic tracing with request IDsUsing X-Request-IDManaging database connectionsTo ORM or not to ORM, that is the questionCreating a custom data access layer in SanicConnecting Sanic to RedisSummary
Technical requirementsSynchronizing and scaling websocket feedsPowering a progressive web applicationDealing with subdomains and CORSRunning a development serverDesigning a GraphQL APIWhy would I want to use GraphQL?Adding GraphQL to SanicBuilding a Discord bot: running Sanic from another serviceBuilding a simple Discord botRunning the Discord bot from SanicCreating an HTTP to HTTPS proxy: nesting Sanic inside SanicSummary
Technical requirementsThe process of building a web applicationStep 1—Define the functionality and workflowStep 2—Decide on the technology stackStep 3—Architect the data structuresStep 4—Plan and build the user interfaceStep 5—Build the application infrastructureStep 6—Prototype the minimally viable backend featuresStep 7—Create continuous integration, deployment, and automation toolsStep 8—Iterate, iterate, iterateHighlighting select features of the BooktrackerDevelopment environmentCreating a better factory pattern with setup functionsThe data access layerAuthentication flowSummaryPutting it all together
Other Books You May EnjoyPackt is searching for authors like youShare Your Thoughts

Content preview from Python Web Development with Sanic

Part 3:Putting It All together

After spending time looking at specific issues individually, we start to look at how some issues relate to one another. This part will include a lot more examples and code snippets. A lot of the code will only be available online, so you will be highly encouraged to also flip through the source code repository on GitHub: https://github.com/PacktPublishing/Python-Web-Development-with-Sanic. The goal is once again to provide you with knowledge, not snippets.

This Part contains the following chapters:

Chapter 9, Best Practices to Improve Your Web Applications
Chapter 10, Implementing Common Use Cases with Sanic
Chapter 11, A Complete Real-World Example

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Start your free trial

Python Microservices Development

Tarek Ziadé

Decoupled Django: Understand and Build Decoupled Django Architectures for JavaScript Front-ends

Valentino Gagliardi

Advanced Python Development: Using Powerful Language Features in Real-World Applications

Matthew Wilkes

Serverless Applications with Node.js

Aleksandar Simovic, Slobodan Stojanovic

Publisher Resources

ISBN: 9781801814416Supplemental Content