Register new style

[flywire]

Closes #980

[Anteru]

Could you please add a test which exercises the new behavior?

[jeanas]

Could you please add a test which exercises the new behavior?

Um, for a doc PR about patching the sources?

Though, isn't it better to document how to register a style via a plugin rather than by patching your Pygments distribution?

[Anteru]

Ok so wait, default_style was never used previously? I thought this would be an observable behavior change if someone relied on default_style but guess I was mistaken?

[jeanas]

I think you're confusing issues #980, which this fixes, and #2184, which is unrelated.

[birkenfeld]

Regarding this PR: I think the advice to copy stuff into the Pygments package should be removed wholesale, or at least clarified to only apply if you add a new style for submission as a PR.

[jeanas]

Regarding this PR: I think the advice to copy stuff into the Pygments package should be removed wholesale, or at least clarified to only apply if you add a new style for submission as a PR.

+1

[flywire]

@birkenfeld bd9eff0 only tries to represent the existing information more simply. The main need for it is the manual change to __init__.py. It would be easier if you just made any change you have in mind.

---

https://pygments.org/docs/ Hacking for Pygments is written around changing the Pygments package. I don't disagree it should be written around developing a Plugin but the section would need rewriting. It should start with https://pygments.org/docs/plugins/ containing a fully working your plugin consistent with the rest of the section. The emphasis of the other parts of this section should be reworked to be directed more towards the plugin than the package.

[jeanas]

This is from get_style_by_name in styles/__init__.py:

def get_style_by_name(name):
    if name in STYLE_MAP:
        mod, cls = STYLE_MAP[name].split('::')
        builtin = "yes"
    else:
        for found_name, style in find_plugin_styles():
            if name == found_name:
                return style
        # perhaps it got dropped into our styles package
        builtin = ""
        mod = name
        cls = name.title() + "Style"

Ugh. I wonder if this should be left undocumented or just removed.

[flywire]

It's not documented in the existing guide but implied. The guide has example style code followed by "That's it.". It truly is it if the file is placed into the style folder and the user doesn't need the services from registering the style (ie bringing up on a list of styles).

It's useful functionality so I wouldn't remove it but it is probably not worth any more documentation than a comment in the code.

[birkenfeld]

Hm, I don't like that either. It's also different from other components (lexers, formatters).

[Anteru]

What's the next step here? It feels like we can merge this change and then continue with the rest elsewhere?

[Anteru]

Merged, thanks. I'll add a warning note to the documentation to address @birkenfeld 's feedback. We still need a resolution for get_style_by_name though.