Skip to content

Feature/detect casting comb token from converters#784

Merged
rochacbruno merged 3 commits intodynaconf:masterfrom
jorenretel:feature/detect_casting_comb_token_from_converters
Aug 16, 2022
Merged

Feature/detect casting comb token from converters#784
rochacbruno merged 3 commits intodynaconf:masterfrom
jorenretel:feature/detect_casting_comb_token_from_converters

Conversation

@jorenretel
Copy link
Copy Markdown
Contributor

@jorenretel jorenretel commented Aug 4, 2022 •
edited
Loading

Hi,

first of all: thanks for this amazing library. This makes life a lot easier.

Main

I have a suggestion, but I can not see all the implications it has. What I suggest is to suggest to change the regex that detects whether two casting tokens are used in one variable definition. I think it would be nice if this regex is generated dynamically based on the values in the "converters" dict. What this allows is that a user could add a custom casting token. For instance, I wanted a casting token that would cast the string to a pathlib.Path object (see example/custom_cast_token):

# app.py
from pathlib import Path
from dynaconf.utils import parse_conf

parse_conf.converters["@path"] = (
    lambda value: value.set_casting(Path)
    if isinstance(value, parse_conf.Lazy)
    else Path(value)
)
#settings.toml
some_path = "@path /home/john/foo.txt"

This last thing would also work without changing the regex. But it becomes a problem when I would like to do something like:

# settings.toml

parent = "@path @format {env[HOME]}/parent"
child = "@path @format {this.parent}/child"

The regex as it is now does not pick up "@path @Format" and therefore does not do the format step. This PR would solve that.

As as note. I also, found another solution that does not require changing Dynaconf:

# app.py
from pathlib import Path
parse_conf.converters["@path"] = lambda value: parse_conf.Lazy(value).set_casting(Path)

with the following:

# settings.toml
parent = "@path {env[HOME]}/parent"
child = "@path {this.parent}/child"

but this feels slightly hacky and would not allow to have casting to path without also formatting (which the Lazy does).

Tests

Before submitting this pull request I ran "make test_only" and that all passes. I also ran "make all", there I ran into some "maximum recursion depth reached" error. I already had this problem before making any changes though. I followed https://github.com/dynaconf/dynaconf/blob/master/CONTRIBUTING.md , but I must be doing something wrong. I have a similar (but not exactly the same) Traceback when I don't initialize settings like this:

settings = Dynaconf(
    envvar_prefix="DYNACONF",
    settings_files=["settings.toml"],
    environments=True,
)

but import them like I see in the other examples:

from dynaconf import settings

@rochacbruno rochacbruno mentioned this pull request Aug 16, 2022
Closed
@rochacbruno rochacbruno merged commit 5297d07 into dynaconf:master Aug 16, 2022
rochacbruno added a commit that referenced this pull request Sep 22, 2022
@rochacbruno
Release version 3.1.10
c7a3092 
Shortlog of commits since last release:

    Amadou Crookes (1):
          envars.md typo fix (#786)

    Bruno Rocha (19):
          Release version 3.1.9
          Bump dev version to 3.1.10
          Update badges
          demo repo will be replaced by a video tutorial soon
          Fix CI
          New data key casing must adapt to existing key casing (#795)
          Add test and docs about includes (#796)
          Removed vendor_src folder (#798)
          Replacing rochacbruno/ with dynaconf/ (#800)
          Fix codecov (#801)
          Parse negative numbers from envvar Fix #799 and Fix #585 (#802)
          Fix get command with Django (#804)
          Add a functional test runner (#805)
          Test runner docs and styling (#806)
          Allow merge_unique on lists when merge_enabled=True (#810)
          Rebind current env when forced for Pytest Fix #728 (#809)
          AUTO_CAST can be enabled on instance (#811)
          Ensure pyminify is on release script
          Add missing tomllib to monify script

    Gaurav Talreja (1):
          Fix #807 Use client.auth.approle.login instead of client.auth_approle (#808)

    Jitendra Yejare (1):
          Fix #768 of kv property depreciation from client object (#769)

    Joren Retel (2):
          Feature/detect casting comb token from converters (#784)
          Adding documentation and example to makefile. (#791)

    João Gustavo A. Amorim (1):
          Add pyupgrade hook (#759)

    Kian-Meng Ang (1):
          Fix typos (#788)

    Lucas Limeira (1):
          Using filter_strategy in env_loader to fix #760 (#767)

    Nicholas Nadeau, Ph.D., P.Eng (1):
          fix: typo (#766)

    Oleksii Baranov (2):
          Bump codecov action version (#775)
          Fix cli init command for flask (#705) (#774)

    Pedro de Medeiros (1):
          documentation fixes (#771)

    The Gitter Badger (1):
          Add a Gitter chat badge to README.md (#776)

    Théo Melo (1):
          Fixing a typo on the readme file (#763)

    Vicente Marçal (1):
          docs(pt-br): Docs Translation to brazilian portugues. (#787)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rochacbruno rochacbruno rochacbruno approved these changes

Assignees

No one assigned

Labels

Docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jorenretel @rochacbruno