add XDG_CONFIG_HOME for py3status, organize paths #1694

lasers · 2019-02-05T22:07:48Z

This add ~~sensible~~ xdg config paths for py3status. Ref: #1584 (comment)

maximbaz · 2019-02-05T22:13:18Z

py3status/cli.py

@@ -63,6 +63,8 @@ def parse_cli():
    # i3status config file default detection
    # respect i3status' file detection order wrt issue #43
    i3status_config_file_candidates = [
+        "{}/py3status/py3status.conf".format(xdg_home_path),
+        "{}/py3status/config".format(xdg_home_path),


I think having one file ~/.config/py3status/config is enough, no need to introduce multiple alternatives - this one is similar to ~/.config/i3status/config, let's go with it.

We have three i3status.conf and not one py3status.conf... and if users don't like ~/.config/py3status/config, they have an option to use py3status.conf... then -c.

What stands out... ~/.i3/i3status.conf, ~/.config/i3/i3status.conf, etc. They all are in "wrong" / convenience places... and it looks like /etc/xdg/i3status/config is nearly at end of the list instead of nearly at top of the list according to i3status man page. Is i3status man page wrong or out of date?

EDIT: We can't say py3status.conf if we don't support it. Put the name out there.

I cannot imagine why someone would not like ~/.config/py3status/config if that's a perfectly reasonable XDG compliant file name, my point was just that we already have a zoo of config locations and adding two more seems excessive, one is enough in my mind. But I don't have a strong opinion, so I approve the PR. Perhaps worth getting others' opinions before merging.

I don't have a strong opinion too. I personally use ~/.config/py3status/bottom.conf... and if I really need more, I will turn on top.conf or test.conf.

Also, because it's easier to jump open v py3status.conf in shell than v py3 config... not working or opening wrong one... so you do v config py3st conf. Random examples.

Other than that, I think we should support ~/.config/py3status/py3status.conf because this PR would make it xdg friendly (EDIT: for py3status). At same time, we say we support py3status.conf now too. Idk.

ultrabug · 2019-02-10T20:43:52Z

If we are to add options for XDG, I'd like them to be at the end of the list please

lasers · 2019-02-10T20:50:32Z

I don't get this. Why do we not want py3status name on top of the list to be tested first?

~/.config/py3status/py3status.conf <--- default py3status config (we never had one before)
~/.config/py3status/config <--- honor XDG style to make people happy
test i3status and others next.... all the way to end /etc/i3status.conf.

ultrabug · 2019-02-10T21:06:41Z

Because py3status is an i3status wrapper so we first respect i3status' way of finding out its config, and then if we want to add ours, we can

lasers · 2019-02-10T21:07:58Z

If our py3status config comes first, shouldn't we use that instead though? py3status overrides i3status.

maximbaz · 2019-02-10T21:08:00Z

* ~/.config/py3status/py3status.conf is honoring XDG style too I believe, so maybe we should ditch ~/.config/py3status/config?

ultrabug · 2019-02-10T21:11:56Z

I'm not even sure I like the idea tbh. Our philosophy says : no added configuration file and yet you are proposing to create py3status.conf

There is no need for that tbh

maximbaz · 2019-02-10T21:21:20Z

My opinion is the following: if ~/.config/py3status/py3status.conf and ~/.config/py3status/modules/ were supported, I would definitely use them instead of the current ~/.config/i3/i3status.conf and ~/.config/i3/py3status/ paths, because when I want to edit py3status config, I think of py3status in my head, I don't really think that it's based on i3status and therefore I need to look for i3status config instead 🙂 At the same time, strictly speaking even ~/.config/i3/i3status.conf is XDG-compatible.

So, I'm fine with any choice that you make here 😉

lasers · 2019-02-10T21:24:05Z

Other thing is that if we support this, users don't have to do py3status -c ~/.config/py3status/py3status.conf -i ~/.config/py3status/modules in their i3 config. I admit I use this for long time. Sure on wrapper, but it is py3status I am using, not i3status or i3status.conf.

thiagokokada · 2019-02-24T03:32:35Z

I also would like to have proper XDG_CONFIG_HOME paths. For all things that py3status add I can't simple take my py3status file and run it on i3status. The contrary is true, however the default paths as they current are make it impossible to have a different config file for py3status and i3status (unless of course passing -c switch to py3status, however this seems strange for what should be a common user case).

lasers · 2019-02-27T10:08:34Z

this pr

1) /home/user/.config/py3status/py3status.conf
2) /home/user/.i3status.conf
3) /home/user/.config/i3status/config
4) /home/user/.config/i3/i3status.conf
5) /home/user/.i3/i3status.conf
6) /etc/xdg/i3status/config
7) /etc/i3status.conf

what i think it should be.. after reviewing manuals, commits, etc.
i3status manpage is wrong in current release. is fixed in latest master.
orders changed more than twice in i3status and/or i3 too.

-) /home/user/.config/py3status/config  # py3 xdg path
3) /home/user/.config/i3status/config
4) /home/user/.config/i3/i3status.conf  # custom i3 xdg path
2) /home/user/.i3status.conf
5) /home/user/.i3/i3status.conf  # custom i3 traditional path
6) /etc/xdg/i3status/config
7) /etc/i3status.conf

this part custom. to say and support py3status.conf with confident too (?). this no 1 in list too.

1) /home/user/.config/py3status/py3status.conf  # custom py3 path

but we have (xdg) correct ~/.config/py3status/config so it might not be needed (and may be better to use symbolic links (py3status.conf -> config) to keep it clean. what say you?

lasers · 2019-02-28T03:29:56Z

@ultrabug Can you review this? I remove a duplicate. I find i3/i3status making mistakes over there... and they fixed paths over there too... so I want to organize/paths correctly. If users have a stray config and are detected, then yes, it will use that... only because it's a stray config.

Nothing is removed, but non-official paths would be tested after official paths... not before.

You can review/test paths this with:

diff --git a/py3status/argparsers.py b/py3status/argparsers.py
index 2f811f8..e323587 100644
--- a/py3status/argparsers.py
+++ b/py3status/argparsers.py
@@ -183,6 +183,15 @@ def parse_cli_args():
             "{}/.i3/py3status".format(home_path),
         ]
 
+    print('---i3status config paths--------')
+    for x in i3status_config_file_candidates:
+        print(x)
+    print("")
+    print('---module paths--------')
+    for x in options.include_paths:
+        print(x)
+    parser.exit()
+
     include_paths = []
     for path in options.include_paths:
         path = os.path.abspath(path)

ultrabug · 2019-03-24T18:00:43Z

OK guys I agree with you, thanks for taking the time to convince me :)

All I ask now is an updated documentation about this please

…xdg-config-home

ultrabug · 2019-03-25T08:41:37Z

I updated the docs

lasers added this to the 4.0 milestone Feb 5, 2019

maximbaz reviewed Feb 5, 2019

View reviewed changes

maximbaz approved these changes Feb 5, 2019

View reviewed changes

lasers force-pushed the xdg-config-home branch from 45140d7 to 3abbb86 Compare February 10, 2019 20:56

lasers force-pushed the xdg-config-home branch from 3abbb86 to 311cb6d Compare February 10, 2019 21:37

lasers force-pushed the xdg-config-home branch from 311cb6d to 566ba01 Compare February 28, 2019 03:22

lasers force-pushed the xdg-config-home branch from 566ba01 to 9cf03dd Compare March 4, 2019 22:22

maximbaz mentioned this pull request Mar 12, 2019

update i3wm.github.io py3status page with newer links and doc fix #1010 #1745

Merged

lasers force-pushed the xdg-config-home branch 3 times, most recently from 650ce9c to 5174cbd Compare March 16, 2019 21:54

lasers changed the title ~~add XDG_CONFIG_HOME paths for py3status~~ argparsers: add XDG_CONFIG_HOME for py3status, organize paths Mar 16, 2019

add XDG_CONFIG_HOME for py3status, organize paths

225e5a5

lasers force-pushed the xdg-config-home branch from 5174cbd to 225e5a5 Compare March 16, 2019 21:56

lasers changed the title ~~argparsers: add XDG_CONFIG_HOME for py3status, organize paths~~ add XDG_CONFIG_HOME for py3status, organize paths Mar 16, 2019

ultrabug and others added 3 commits March 24, 2019 19:00

Merge branch 'master' into xdg-config-home

79efdff

report config file and include paths during startup

340c2da

group stop cycling on urgent module closes #890 (#1753)

431dd38

ultrabug added 4 commits March 24, 2019 14:04

ensure click events have an index key

0f32079

fix markup support on composites

a9ae1bd

version 3.17

d80a1cd

report config file and include paths during startup

8e3e638

lasers force-pushed the xdg-config-home branch from 340c2da to ce08f3c Compare March 24, 2019 19:05

lasers requested a review from ultrabug March 24, 2019 19:06

lasers force-pushed the xdg-config-home branch from ce08f3c to e18c8f1 Compare March 24, 2019 19:16

docs: update documentation for config and module paths

9082794

lasers force-pushed the xdg-config-home branch from e18c8f1 to 9082794 Compare March 24, 2019 19:17

ultrabug added 2 commits March 25, 2019 09:37

update docs for configuration and writing modules

091ac0f

Merge branch 'xdg-config-home' of github.com:ultrabug/py3status into …

6104353

…xdg-config-home

ultrabug merged commit 6d1523d into master Mar 25, 2019

lasers deleted the xdg-config-home branch March 25, 2019 08:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add XDG_CONFIG_HOME for py3status, organize paths #1694

add XDG_CONFIG_HOME for py3status, organize paths #1694

lasers commented Feb 5, 2019

maximbaz Feb 5, 2019

lasers Feb 5, 2019 •

edited

Loading

maximbaz Feb 5, 2019

lasers Feb 5, 2019 •

edited

Loading

ultrabug commented Feb 10, 2019

lasers commented Feb 10, 2019

ultrabug commented Feb 10, 2019

lasers commented Feb 10, 2019

maximbaz commented Feb 10, 2019

ultrabug commented Feb 10, 2019

maximbaz commented Feb 10, 2019

lasers commented Feb 10, 2019 •

edited

Loading

thiagokokada commented Feb 24, 2019

lasers commented Feb 27, 2019 •

edited

Loading

lasers commented Feb 28, 2019 •

edited

Loading

ultrabug commented Mar 24, 2019

ultrabug commented Mar 25, 2019

add XDG_CONFIG_HOME for py3status, organize paths #1694

add XDG_CONFIG_HOME for py3status, organize paths #1694

Conversation

lasers commented Feb 5, 2019

maximbaz Feb 5, 2019

Choose a reason for hiding this comment

lasers Feb 5, 2019 • edited Loading

Choose a reason for hiding this comment

maximbaz Feb 5, 2019

Choose a reason for hiding this comment

lasers Feb 5, 2019 • edited Loading

Choose a reason for hiding this comment

ultrabug commented Feb 10, 2019

lasers commented Feb 10, 2019

ultrabug commented Feb 10, 2019

lasers commented Feb 10, 2019

maximbaz commented Feb 10, 2019

ultrabug commented Feb 10, 2019

maximbaz commented Feb 10, 2019

lasers commented Feb 10, 2019 • edited Loading

thiagokokada commented Feb 24, 2019

lasers commented Feb 27, 2019 • edited Loading

lasers commented Feb 28, 2019 • edited Loading

ultrabug commented Mar 24, 2019

ultrabug commented Mar 25, 2019

lasers Feb 5, 2019 •

edited

Loading

lasers Feb 5, 2019 •

edited

Loading

lasers commented Feb 10, 2019 •

edited

Loading

lasers commented Feb 27, 2019 •

edited

Loading

lasers commented Feb 28, 2019 •

edited

Loading