Add pytest-examples and make examples in docs testable

[hramezani]

Fixes #33

[codecov-commenter]

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (142b9cf) 95.37% compared to head (cbd1d2d) 95.37%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #56   +/-   ##
=======================================
  Coverage   95.37%   95.37%           
=======================================
  Files           5        5           
  Lines         303      303           
  Branches       69       69           
=======================================
  Hits          289      289           
  Misses         12       12           
  Partials        2        2           

Impacted Files	Coverage Δ
pydantic_settings/sources.py	95.34% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[samuelcolvin]

I don't see the test code using pytest-examples - I guess you need to add that file?

[samuelcolvin]

I think the idea here was that these fields were required - then set via env vars. Probably best if you can set the appropriate env vars in the test so this works without modifiation.

[hramezani]

Done

[samuelcolvin]

maybe you can see these in the test?

[hramezani]

Sorry, didn't get this comment. Do you mean to convert them to a test function here?

[samuelcolvin]

you can move all this logic into test setup.

[samuelcolvin]

e.g. set a bunch of env variables before running all or specific tests, then remove them after.

[hramezani]

I've added a fixture

[samuelcolvin]

i think you should just use print, pytest-examples should take care of formatting the output with black.

[hramezani]

Didn't work with print.

――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― test_docs_examples[docs/index.md:14-72] ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――
Print output changed code:
  --- before
  +++ after
  @@ -56,30 +56,21 @@
       model_config = ConfigDict(env_prefix='my_prefix_')  # defaults to no prefix, i.e. ""
 
 
   print(Settings().model_dump())
   """
  -{
  -    'auth_key': '',
  -    'api_key': '',
  -    'redis_dsn': Url('redis://user:pass@localhost:6379/1'),
  -    'pg_dsn': Url('postgres://user:pass@localhost:5432/foobar'),
  -    'amqp_dsn': Url('amqp://user:pass@localhost:5672/'),
  -    'special_function': <built-in function cos>,
  -    'domains': set(),
  -    'more_settings': {'foo': 'bar', 'apple': 1},
  -}
  +{'auth_key': '', 'api_key': '', 'redis_dsn': Url('redis://user:pass@localhost:6379/1'), 'pg_dsn': Url('postgres://user:pass@localhost:5432/foobar'), 'amqp_dsn': Url('amqp://user:pass@localhost:5672/'), 'special_function': <built-in function cos>, 'domains': set(), 'more_settings': {'foo': 'bar', 'apple': 1}}
   """

[hramezani]

Ok, I've replaced it with print but it doesn't work with formatted output.
we can ignore it for now.

[samuelcolvin]

otherwise LGTM, I committed to fix the issue with formatting the first example.

[samuelcolvin]

you can move all this logic into test setup.

[samuelcolvin]

e.g. set a bunch of env variables before running all or specific tests, then remove them after.

[hramezani]

@samuelcolvin It's ready

[samuelcolvin]

Thanks so much.