{"id":135330,"date":"2024-09-06T10:31:02","date_gmt":"2024-09-06T05:01:02","guid":{"rendered":"https:\/\/www.vskills.in\/certification\/tutorial\/?page_id=135330"},"modified":"2024-09-06T10:34:39","modified_gmt":"2024-09-06T05:04:39","slug":"creating-config-files-using-pydantic","status":"publish","type":"page","link":"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/","title":{"rendered":"Creating Config Files Using Pydantic"},"content":{"rendered":"\n<p>In FastAPI, using configuration files is a common practice to manage application settings, database credentials, and other environment-specific variables. Pydantic, a powerful data validation library, can be used to create and validate configuration files in a structured and type-safe manner.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Creating a Configuration Model<\/strong><\/h2>\n\n\n\n<p><strong>Import Pydantic:<\/strong><\/p>\n\n\n\n<p>Python<\/p>\n\n\n\n<p><code>from pydantic import BaseModel<\/code><\/p>\n\n\n\n<p><strong>Define the Configuration Model:<\/strong><\/p>\n\n\n\n<p>Python<\/p>\n\n\n\n<p><code>class Settings(BaseModel): <\/code><\/p>\n\n\n\n<p><code>debug: bool = True <\/code><\/p>\n\n\n\n<p><code>database_url: str = \"postgresql:\/\/user:password@host:port\/database\" <\/code><\/p>\n\n\n\n<p><code>secret_key: str <\/code><\/p>\n\n\n\n<p>This <code class=\"\">Settings<\/code> model defines three configuration options: <code class=\"\">debug<\/code>, <code class=\"\">database_url<\/code>, and <code class=\"\">secret_key<\/code>. The <code class=\"\">debug<\/code> option is set to <code class=\"\">True<\/code> by default, while the <code class=\"\">database_url<\/code> and <code class=\"\">secret_key<\/code> options are left as required fields.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Loading the Configuration<\/strong><\/h2>\n\n\n\n<p><strong>Create a Function to Load the Configuration:<\/strong><\/p>\n\n\n\n<p>from dotenv import load_dotenv<br>from pathlib import Path<\/p>\n\n\n\n<p>def get_settings():<br>load_dotenv()<br>return Settings()<\/p>\n\n\n\n<p>This function loads environment variables from a <code class=\"\">.env<\/code> file using the <code class=\"\">dotenv<\/code> library and creates a <code class=\"\">Settings<\/code> instance using the loaded values.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Using the Configuration in FastAPI<\/strong><\/h2>\n\n\n\n<p><strong>Create a Dependency:<\/strong><\/p>\n\n\n\n<p>from fastapi import Depends<\/p>\n\n\n\n<p>def get_settings(settings: Settings = Depends(get_settings)):<br>return settings<\/p>\n\n\n\n<p><strong>Inject the Configuration into Endpoints:<\/strong><\/p>\n\n\n\n<p>from fastapi import APIRouter, Depends<\/p>\n\n\n\n<p>router = APIRouter()<\/p>\n\n\n\n<p>@router.get(&#8220;\/&#8221;)<br>def read_root(settings: Settings = Depends(get_settings)):<br>return {&#8220;debug&#8221;: settings.debug, &#8220;database_url&#8221;: settings.database_url}<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Additional Considerations<\/strong><\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Environment Variables:<\/strong> You can set configuration values as environment variables and load them using the <code class=\"\">dotenv<\/code> library. This allows you to manage different configurations for different environments (e.g., development, testing, production).<\/li>\n\n\n\n<li><strong>Secret Management:<\/strong> For sensitive information like API keys or database passwords, consider using a secret management service or storing them in environment variables that are not checked into your source code.<\/li>\n\n\n\n<li><strong>Validation:<\/strong> Pydantic provides built-in validation to ensure that configuration values adhere to the specified types and constraints.<\/li>\n\n\n\n<li><strong>Configuration Files:<\/strong> While using environment variables is a common approach, you can also store configuration values in dedicated configuration files (e.g., <code class=\"\">settings.py<\/code>) and load them using Python&#8217;s built-in configuration modules.<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>In FastAPI, using configuration files is a common practice to manage application settings, database credentials, and other environment-specific variables. Pydantic, a powerful data validation library, can be used to create and validate configuration files in a structured and type-safe manner. Creating a Configuration Model Import Pydantic: Python from pydantic import BaseModel Define the Configuration Model:&#8230;<\/p>\n","protected":false},"author":16,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"categories":[],"tags":[],"class_list":["post-135330","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.5 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Creating Config Files Using Pydantic - Tutorial<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Creating Config Files Using Pydantic - Tutorial\" \/>\n<meta property=\"og:description\" content=\"In FastAPI, using configuration files is a common practice to manage application settings, database credentials, and other environment-specific variables. Pydantic, a powerful data validation library, can be used to create and validate configuration files in a structured and type-safe manner. Creating a Configuration Model Import Pydantic: Python from pydantic import BaseModel Define the Configuration Model:...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/\" \/>\n<meta property=\"og:site_name\" content=\"Tutorial\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/vskills.in\/\" \/>\n<meta property=\"article:modified_time\" content=\"2024-09-06T05:04:39+00:00\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/\",\"url\":\"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/\",\"name\":\"Creating Config Files Using Pydantic - Tutorial\",\"isPartOf\":{\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#website\"},\"datePublished\":\"2024-09-06T05:01:02+00:00\",\"dateModified\":\"2024-09-06T05:04:39+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.vskills.in\/certification\/tutorial\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Creating Config Files Using Pydantic\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#website\",\"url\":\"https:\/\/www.vskills.in\/certification\/tutorial\/\",\"name\":\"Tutorial\",\"description\":\"Vskills - A initiative in elearning and certification\",\"publisher\":{\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.vskills.in\/certification\/tutorial\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#organization\",\"name\":\"Vskills\",\"url\":\"https:\/\/www.vskills.in\/certification\/tutorial\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.vskills.in\/certification\/tutorial\/wp-content\/uploads\/2017\/07\/vskills-min-logo.jpg\",\"contentUrl\":\"https:\/\/www.vskills.in\/certification\/tutorial\/wp-content\/uploads\/2017\/07\/vskills-min-logo.jpg\",\"width\":73,\"height\":55,\"caption\":\"Vskills\"},\"image\":{\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/vskills.in\/\",\"https:\/\/x.com\/vskills_in\",\"https:\/\/www.linkedin.com\/company-beta\/1371554\/\",\"https:\/\/www.youtube.com\/channel\/UCMWnscxPwRF_PqXo9B7q_Tw\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Creating Config Files Using Pydantic - Tutorial","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/","og_locale":"en_US","og_type":"article","og_title":"Creating Config Files Using Pydantic - Tutorial","og_description":"In FastAPI, using configuration files is a common practice to manage application settings, database credentials, and other environment-specific variables. Pydantic, a powerful data validation library, can be used to create and validate configuration files in a structured and type-safe manner. Creating a Configuration Model Import Pydantic: Python from pydantic import BaseModel Define the Configuration Model:...","og_url":"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/","og_site_name":"Tutorial","article_publisher":"https:\/\/www.facebook.com\/vskills.in\/","article_modified_time":"2024-09-06T05:04:39+00:00","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/","url":"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/","name":"Creating Config Files Using Pydantic - Tutorial","isPartOf":{"@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#website"},"datePublished":"2024-09-06T05:01:02+00:00","dateModified":"2024-09-06T05:04:39+00:00","breadcrumb":{"@id":"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/creating-config-files-using-pydantic\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.vskills.in\/certification\/tutorial\/"},{"@type":"ListItem","position":2,"name":"Creating Config Files Using Pydantic"}]},{"@type":"WebSite","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#website","url":"https:\/\/www.vskills.in\/certification\/tutorial\/","name":"Tutorial","description":"Vskills - A initiative in elearning and certification","publisher":{"@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.vskills.in\/certification\/tutorial\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#organization","name":"Vskills","url":"https:\/\/www.vskills.in\/certification\/tutorial\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#\/schema\/logo\/image\/","url":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-content\/uploads\/2017\/07\/vskills-min-logo.jpg","contentUrl":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-content\/uploads\/2017\/07\/vskills-min-logo.jpg","width":73,"height":55,"caption":"Vskills"},"image":{"@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/vskills.in\/","https:\/\/x.com\/vskills_in","https:\/\/www.linkedin.com\/company-beta\/1371554\/","https:\/\/www.youtube.com\/channel\/UCMWnscxPwRF_PqXo9B7q_Tw"]}]}},"_links":{"self":[{"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/pages\/135330","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/users\/16"}],"replies":[{"embeddable":true,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/comments?post=135330"}],"version-history":[{"count":2,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/pages\/135330\/revisions"}],"predecessor-version":[{"id":135354,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/pages\/135330\/revisions\/135354"}],"wp:attachment":[{"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/media?parent=135330"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/categories?post=135330"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/tags?post=135330"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}