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

Python plugins: add default module_path to search path #1038

Merged
merged 10 commits into from
Feb 7, 2022
Merged

Python plugins: add default module_path to search path #1038

merged 10 commits into from
Feb 7, 2022

Conversation

joergsteffens
Copy link
Member

@joergsteffens joergsteffens commented Dec 23, 2021 •
edited by sduehr
Loading

Currently all Python modules get installed to the plugin directory.
However, every plugin configuration requires the parameter module_path set to this value.

This PR adds the Python Plugin module path to the default search path, so that specifying the module_path is only unnecessary in non-standard installations.

OP#5043

Please check

  • Short description and the purpose of this PR is present above this paragraph
  • Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

General
  • PR name is meaningful
  • Purpose of the PR is understood
  • Separate commit for this PR in the CHANGELOG.md, PR number referenced is same
  • Commit descriptions are understandable and well formatted
Source code quality
  • Source code changes are understandable
  • Variable and function names are meaningful
  • Code comments are correct (logically and spelling)
  • Required documentation changes are present and part of the PR
  • bareos-check-sources --since-merge does not report any problems
  • git status should not report modifications in the source tree after building and testing

@joergsteffens joergsteffens force-pushed the dev/joergs/master/default-plugin-path branch from 5e122ff to edcf6e4 Compare December 23, 2021 11:33
@joergsteffens joergsteffens force-pushed the dev/joergs/master/default-plugin-path branch 2 times, most recently from d153f3c to 1b0b509 Compare January 13, 2022 18:07
@joergsteffens joergsteffens marked this pull request as ready for review January 13, 2022 18:08
@joergsteffens joergsteffens force-pushed the dev/joergs/master/default-plugin-path branch from 1b0b509 to 99ed130 Compare January 20, 2022 13:07
joergsteffens added a commit that referenced this pull request Jan 20, 2022
@joergsteffens
Update CHANGELOG.md: [PR #1038] Python plugins
2e4d7e8
pstorz
pstorz reviewed Jan 26, 2022
View reviewed changes
Copy link
Member

@pstorz pstorz left a comment

Choose a reason for hiding this comment

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

Checked first commit and the changes look good to me.
Good work!

@joergsteffens joergsteffens assigned sduehr and unassigned pstorz Jan 26, 2022
sduehr
sduehr requested changes Jan 28, 2022
View reviewed changes
Copy link
Member

@sduehr sduehr left a comment

Choose a reason for hiding this comment

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

Thanks a lot, only found some typos.

core/src/plugins/dird/python/python-dir.cc Outdated Show resolved Hide resolved
...c/plugins/filed/python/ldap/python-ldap-conf.d/bareos-dir.d/fileset/plugin-ldap.conf.example Outdated Show resolved Hide resolved
core/src/plugins/filed/python/python-fd.cc Outdated Show resolved Hide resolved
core/src/plugins/stored/python/python-sd.cc Outdated Show resolved Hide resolved
docs/manuals/source/Appendix/Howtos.rst Outdated Show resolved Hide resolved
docs/manuals/source/DeveloperGuide/PythonPluginAPI.rst Outdated Show resolved Hide resolved
docs/manuals/source/TasksAndConcepts/Plugins/DirectorPlugins/PythonDirPlugin.rst.inc Outdated Show resolved Hide resolved
docs/manuals/source/TasksAndConcepts/Plugins/DirectorPlugins/PythonDirPlugin.rst.inc Outdated Show resolved Hide resolved
docs/manuals/source/TasksAndConcepts/Plugins/FileDaemonPlugins/PythonFdPlugin.rst.inc Outdated Show resolved Hide resolved
joergsteffens and others added 10 commits February 2, 2022 15:05
@joergsteffens
core: add PYTHON_MODULE_PATH definition
ce9f5bc 
Use PYTHON_MODULE_PATH as default Python module search path for Python plugins.
Also use identical "PyLoadModule" function for all daemons.
Before all 3 python plugins did use there own version
of the PyLoadModule function.
@joergsteffens @sduehr
python plugins: add infos to usage
f673721 
Co-authored-by: sduehr <stephan.duehr@bareos.com>
@joergsteffens
python-plugin: add debug
b5c893b
@joergsteffens
docs: remove unnecessary module_path parameter
63e19db
@joergsteffens
python plugins: remove unnecessary module_path parameter
e956cb0
@joergsteffens
docs: copy Python Plugins description to Developer Guide
2c1d0d9
@joergsteffens
docs: cleanup Python Plugin API sections
2bc6f7f 
Only keep general information about Python Plugins in the "Tasks and Concepts" chapter,
moving the implentation details to the Development Guide chapter.

Change the ordering in the Developement chapter to start with the current version of the Python Plugin:
* Python Plugins for Bareos >= 20
* Python Plugins for Bareos < 20
* Migrating Python Plugins to Bareos >= 20
@joergsteffens
debian: add missing python plugin dependencies
e7e464a
@joergsteffens @sduehr
docs: cleanup Director Python plugin section
d197386 
Co-authored-by: sduehr <stephan.duehr@bareos.com>
@joergsteffens
Update CHANGELOG.md: [PR #1038] Python plugins
6e128f6
@joergsteffens joergsteffens force-pushed the dev/joergs/master/default-plugin-path branch from 689a586 to 6e128f6 Compare February 2, 2022 14:21
@joergsteffens
Copy link
Member Author

@sduehr thank you for your suggestions. I've applied them and then rebased them on master, because of a merge conflict. It would be great, if you can review this PR again. Also 5 check-marks are not set. Do you request changes from my side?

@joergsteffens
Copy link
Member Author

joergsteffens commented Feb 2, 2022 •
edited
Loading

@sduehr one additional thing to consider is if it is appropriate to update the Python plugins version numbers from 4 to 5. Currently for all 3 Python plugins is is defined as:

#define PLUGIN_DATE "May 2020"
#define PLUGIN_VERSION "4"

As discussed: not version change required.

@joergsteffens joergsteffens mentioned this pull request Feb 4, 2022
Merged
12 tasks
sduehr
sduehr approved these changes Feb 7, 2022
View reviewed changes
Copy link
Member

@sduehr sduehr left a comment

Choose a reason for hiding this comment

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

Thanks a lot, looks good now.

@sduehr sduehr merged commit 42c4411 into master Feb 7, 2022
@joergsteffens joergsteffens deleted the dev/joergs/master/default-plugin-path branch March 10, 2022 10:10
pstorz pushed a commit to arogge/bareos that referenced this pull request Apr 26, 2022
@joergsteffens @pstorz
Update CHANGELOG.md: [PR bareos#1038] Python plugins
1ebc8e4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pstorz pstorz pstorz left review comments

@sduehr sduehr sduehr approved these changes

Assignees

@sduehr sduehr

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@joergsteffens @pstorz @sduehr