feat: allow creating parent directories for a file store

[Murtagy]

Description

Allow mkdir True when creating a file store.

Use case is rather small - initially deploying an application with FileStores used.

[Murtagy]

@all-contributors please add @Murtagy

[allcontributors]

@Murtagy

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.27%. Comparing base (95951db) to head (53fe233).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3526   +/-   ##
=======================================
  Coverage   98.27%   98.27%           
=======================================
  Files         328      328           
  Lines       14819    14824    +5     
  Branches     2361     2362    +1     
=======================================
+ Hits        14564    14569    +5     
  Misses        116      116           
  Partials      139      139           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[provinzkraut]

Thanks @Murtagy for the PR :)

In general we can add this but:

1. It should be configurable
2. It should happen once during store startup, in the store's __aenter__

[Murtagy]

Thanks @Murtagy for the PR :)

In general we can add this but:

1. It should be configurable
2. It should happen once during store startup, in the store's __aenter__

1. Why creating 1 folder is fine, but creating 2 has to be configurable. The "allow_create_folders" flag makes sense to me. "allow_create_more_than_1_folder" makes no sense to me.
   Or I misunderstand the flag's purpose?
   UPD: don't mind me, I for some reason thought that 1 dir is made by default, which is not the case
2. I am a little slow in understanding the idea of scopes and the control flow of the framework, so done as a knee-jerk reaction to the exception, in the place where exception is made. Will look into it...

[Alc-Alc]

Thanks @Murtagy for the PR :)
In general we can add this but:

1. It should be configurable
2. It should happen once during store startup, in the store's __aenter__

1. Why creating 1 folder is fine, but creating 2 has to be configurable. The "allow_create_folders" flag makes sense to me. "allow_create_more_than_1_folder" makes no sense to me.
   Or I misunderstand the flag's purpose?
   UPD: don't mind me, I for some reason thought that 1 dir is made by default, which is not the case
2. I am a little slow in understanding the idea of scopes and the control flow of the framework, so done as a knee-jerk reaction to the exception, in the place where exception is made. Will look into it...

You just need one flag create_folders: bool = False. You can do await self.path.mkdir(exist_ok=True, parents= self.create_folders). The choice of naming is up in the air, I am impartial as long as it's self descriptive.

[Murtagy]

@provinzkraut (and/or others 😄), did this change in correct direction?

[provinzkraut]

Looks good @Murtagy, just one more thing I'm afraid :)
I'd prefer if we change the naming from "folders" to "directories". This is the more commonly used term and is also used throughout Litestar.

[Murtagy]

codecov was correctly highlighting that the line I added did not run - the store was not going through context manager. The test succeeded, because the directory was created by other tests, so the parent folder already existed.
Fixed that, but overall not sure if the test harness I made is good, I did not work with pytest before

[Murtagy]

How do I get these running?

[Murtagy]

I think I have addressed all the comments and successfully restarted tests via merging master.
Are we good to go?

[github-actions]

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3526