Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Separate datetime components in logfile names with punctuation #1445

Merged
merged 2 commits into from
May 24, 2024
Merged

Separate datetime components in logfile names with punctuation #1445

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61a1848
Separate time components in logfile names with periods
jwodder May 23, 2024
a847a9b
Use hyphen to separate date & time
jwodder May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dandi/cli/command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ def main(ctx, log_level, pdb=False):

logdir = platformdirs.user_log_dir("dandi-cli", "dandi")
logfile = os.path.join(
logdir, f"{datetime.now(timezone.utc):%Y%m%d%H%M%SZ}-{os.getpid()}.log"
logdir, f"{datetime.now(timezone.utc):%Y.%m.%d.%H.%M.%SZ}-{os.getpid()}.log"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so instead of

20240503020100Z-1853999.log

it would become

2024.05.03.02.01.00Z-1853999.log

which also doesn't help in separating the date from time - IMHO the most important one for readability. What about middle ground of just

Suggested change
logdir, f"{datetime.now(timezone.utc):%Y.%m.%d.%H.%M.%SZ}-{os.getpid()}.log"
logdir, f"{datetime.now(timezone.utc):%Y%m%d.%H%M%SZ}-{os.getpid()}.log"

ie.

20240503.020100Z-1853999.log

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yarikoptic I think just separating the individual components is the most important part for readability. How about keeping the component separators but changing the date-time separator to a hyphen, e.g., 2024.05.03-02.01.00Z-1853999.log?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks better! one more possible iteration: in duct (attn @asmacdo ) ATM we take iso8601 but replacing : with - as well to avoid : in filename (but also lacking Z for timezone depiction)... so it then could be 2024-05-03T02-01-00Z-1853999.log. Frankly using . makes it cleaner. So may be let's go with this last iteration and consider doing the same in duct @asmacdo

)
os.makedirs(logdir, exist_ok=True)
handler = logging.FileHandler(logfile, encoding="utf-8")
Expand Down
Loading