Develop #16

faminours · 2017-10-12T08:29:35Z

Standardize all commands' doc

…elop

Fixes errors in RoutingAlgorithm instanciations : $ bxiarchive-addrts ... [C] bxiarchive-a Uncaught Exception - exiting thread [C] bxiarchive-a TypeError: __init__() takes exactly 2 arguments (1 given)

Simplify Wrapper __init__ super call

add --version option in bxiparserconf addargs

update version

…rectly

Use docstrings with ArgumentParser

…elop

Develop

Use docstrings for author/brief/descriptions Use bxiparserconf's new RawDescriptionFilteredHelpFormat when needed. Set shebang to python2. Standardize copyrights.

jnquintin

do we valid that?

jnquintin · 2017-11-16T19:18:14Z

packaged/bin/bxiconfig

@@ -1,14 +1,14 @@
-#!/usr/bin/env python
+#!/usr/bin/env python2


Did you try under python3?
is it possible to correct the behaviour if it's not working?

jnquintin · 2017-11-16T19:19:51Z

packaged/bin/bxilog-check-order

@@ -1,14 +1,14 @@
-#!/usr/bin/env python
+#!/usr/bin/env python2


jnquintin · 2017-11-16T19:21:16Z

packaged/bin/bxilog-check-order

-# Please contact Bull S. A. S. for details about its license.
-###############################################################################
+"""
+@author BXIHL <bxihl@atos.net>


Do we remove the authors?
You could add a contact address but the author is the author...

jnquintin · 2017-11-16T19:22:02Z

packaged/bin/bxilog-console

@@ -1,15 +1,13 @@
-#!/usr/bin/env python
+#!/usr/bin/env python2


same does it not work under python3?

jnquintin · 2017-11-16T19:22:35Z

packaged/bin/bxilog-console

-           Please contact Bull SAS for details about its license.\n
-           Bull - Rue Jean Jaurès - B.P. 68 - 78340 Les Clayes-sous-Bois
-@namespace bxilog-console Monitoring console of a bxilog process
+@author BXIHL <bxihl@atos.net>


idem author. I don't know any bxihl guy.

jnquintin · 2017-11-16T19:23:21Z

packaged/bin/bxilog-parser

@@ -1,14 +1,12 @@
-#!/usr/bin/env python
+#!/usr/bin/env python2


again python3?

jnquintin · 2017-11-16T19:23:43Z

packaged/bin/bxilog-producer

@@ -1,15 +1,13 @@
-#!/usr/bin/env python
+#!/usr/bin/env python2


again python3?

trosh · 2017-11-21T13:50:49Z

About Python2/3: 95% of BXI code is Python2-specific. I have nothing against either making it Python3-specific or Python2/3-compatible, but it's just not something that has been done yet. In the meantime, setting the shebang lines to correspond to the dependency that has been used throughout BXI code makes more sense than leaving the status-quo "unless you can prove that it's not Python3-compatible". Changing the shebang lines would allow having python point to python3 (the default in most-if-not-all Linux distros) without breaking BXI.

About authors=BXIHL: since the actual information of who the author is should be found in Git history, and copyright ownership is Bull's, this top line merely serves as contact information for the client. In practice setting this line manually has caused it to be wrong many times, and the work to keep it correct is just never a priority. Furthermore BXIHL authors tend to stop being maintainers of their code, so the email address shown should be one that lasts longer than that of individual authors.
I'm not against changing @author to @contact, but that is not a Doxygen special command.

jnquintin · 2017-11-21T18:28:41Z

Which BXI do you speak of, here on bxibase 95% of the code is compatible. The small part which is not is from the test of posless. Even the packaging has been moved to generate python3 rpm. So yes the code is compatible and should be that way.
I won't speak about other code there since it's on GitHub.

For the author in the file is not used as contact, there is another contact url in the BXIASSERT and in the version file.
author doesn't mean contact.

trosh · 2017-11-22T11:19:43Z

Launching bxilog-parser with Python 3:

ModuleNotFoundError: No module named 'Queue'

OK, I can use the commented Python 2/3 compatible block

Traceback (most recent call last):
  File "bxilog-parser", line 81, in <module>
    BLOB2STR_TRANSLATE_TABLE = string.maketrans(_NON_PRINTABLE_STR, _NON_PRINTABLE_SUB)
AttributeError: module 'string' has no attribute 'maketrans'

This can also be made compatible, but it's once again just not something that has been done.
Let's say we use a workaround (str.maketrans instead of string.maketrans):

TypeError: Required argument 'file' (pos 1) not found
<module> at bxilog-parser:453
  main()
main at bxilog-parser:449
  _enqueue_input(args.input, q, args.last)
_enqueue_input at bxilog-parser:266
  input_file = open(name=input_filename, mode='rU', buffering=1)

Once again this can be made compatible ... in the meantime you can't pretend it has been, and the existing status-quo is less correct than the idea it could be fixed. This pull request does not aim to reach compatibility, however removing any amount of status-quo seems to me to be a "free" change that can be added in a commit with close-by changes.

Launching bxiconfig with Python 3:

AttributeError: 'ConfigObj' object has no attribute 'has_key'
<module> at bxiconfig:41
  if conf_file_obj.has_key('modules'):

This is just another example.

Everything BXI has been first written in old-school Python 2, with shebang lines set to the non-explicit "python" in all command scripts. IMO they should all be replaced with "python2", unless explicit effort has been made and verified for Python 2/3 compatibility, in which case it should be explicited after the shebang line. This would differenciate from the existing status quo — had everything been written from the start with compatibility in mind, maybe using "python" with no extra info could make sense, but it's not the case.

Do you want to add compatibility with Python 3? It's just not the same language as Python 2 and compatibility does not come cheap; it also means extra maintainability. My experience of Python 2/3 tells me you're better off writing with only one major version in mind, and being explicit about the version change rather than aiming for general compatibility.

Concerning author versus contact: I am OK with removing author line altogether. I thought BXIHL was fine in the same way that GNU's ls has the word GNU distributed in its documentation, but I admit it feels a bit weird as well being used as "author" information. I'm fine with leaving contact info as it currently is, but I don't think having individual people's @atos.net email address in the scripts is really useful in the long term. Maybe if you want to add your personal address in contact info that could make sense, otherwise letting potential users raise issues in the GitHub page is a practice that has become quite common for most products that rely on GitHub for their source.

jnquintin and others added 30 commits August 7, 2017 13:16

improve net-snmp detection

fd58d87

Guess automagically the flags from build_cpu

6243336

Remove duplicated test

2f65eab

use uppercase in hex output

ae08f12

Try compatibility python 2 and 3

5b24f61

Compatibility python 2 and 3 done

8ce3f05

Add tests python 3

d9df63e

Fix imports for Python 2.7

c6292bd

Update dependencies

644ee72

Explicit error on cffi_h load fail (needs to be gen'd with bximake)

f2db299

Correct raise of exception

3fab522

Correct PKG config check

192983b

Correct compilation on c++

001e98d

Merge branch 'develop' of https://github.com/OpenBXI/bxibase into dev…

7b3be7b

…elop

Correct log parser reg exp

1877245

move macro [un]likely to bxi[un]likely

93f6755

Correct configure on windows

57959de

Use sudo for installatino

3039801

Allow python3

d8b1110

update version

5410cb3

Simplify Wrapper __init__ super call

2d40751

Fixes errors in RoutingAlgorithm instanciations : $ bxiarchive-addrts ... [C] bxiarchive-a Uncaught Exception - exiting thread [C] bxiarchive-a TypeError: __init__() takes exactly 2 arguments (1 given)

Merge pull request OpenBXI#12 from trosh/wrapperfix

584d901

Simplify Wrapper __init__ super call

add --version option in bxiparserconf addargs

48f96e5

Merge pull request OpenBXI#13 from faminours/develop

56621ad

add --version option in bxiparserconf addargs

[MSC] Add devel package dependency

8fb1177

Updating shared

c073c24

Simplify output in bxilog-parser

293b5d7

[minor] Don't recalculate timestamp-len dots in bxilog-parser

47207a9

[minor] Don't recalculate color codes in bxilog-parser

84cc24e

[bugfix] Remove invalid import

0624a48

smiquee and others added 9 commits October 6, 2017 10:21

Merge pull request OpenBXI#11 from sdahmani/develop

b277ca8

update version

[misc] Cleanup summary.py

4033227

[feature] Parse author/brief/description from docstring

2edb5b5

[feature] Allow formatting help with raw description but filtered cor…

3fb33e6

…rectly

Merge pull request OpenBXI#14 from trosh/develop

db3773f

Use docstrings with ArgumentParser

Merge branch 'develop' of https://github.com/OpenBXI/bxibase into dev…

277cc59

…elop

Updating shared

0f7ad16

Merge pull request OpenBXI#15 from faminours/develop

bea9b0f

Develop

[misc] [doc] Standardize all commands' doc

1f07f37

Use docstrings for author/brief/descriptions Use bxiparserconf's new RawDescriptionFilteredHelpFormat when needed. Set shebang to python2. Standardize copyrights.

jnquintin reviewed Nov 16, 2017

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Develop #16

Develop #16

Uh oh!

faminours commented Oct 12, 2017

Uh oh!

jnquintin left a comment

Uh oh!

jnquintin Nov 16, 2017

Uh oh!

jnquintin Nov 16, 2017

Uh oh!

jnquintin Nov 16, 2017

Uh oh!

jnquintin Nov 16, 2017

Uh oh!

jnquintin Nov 16, 2017

Uh oh!

jnquintin Nov 16, 2017

Uh oh!

jnquintin Nov 16, 2017

Uh oh!

trosh commented Nov 21, 2017

Uh oh!

jnquintin commented Nov 21, 2017

Uh oh!

trosh commented Nov 22, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		@@ -1,14 +1,14 @@
		#!/usr/bin/env python
		#!/usr/bin/env python2

		@@ -1,15 +1,13 @@
		#!/usr/bin/env python
		#!/usr/bin/env python2

		@@ -1,14 +1,12 @@
		#!/usr/bin/env python
		#!/usr/bin/env python2

Develop #16

Are you sure you want to change the base?

Develop #16

Uh oh!

Conversation

faminours commented Oct 12, 2017

Uh oh!

jnquintin left a comment

Choose a reason for hiding this comment

Uh oh!

jnquintin Nov 16, 2017

Choose a reason for hiding this comment

Uh oh!

jnquintin Nov 16, 2017

Choose a reason for hiding this comment

Uh oh!

jnquintin Nov 16, 2017

Choose a reason for hiding this comment

Uh oh!

jnquintin Nov 16, 2017

Choose a reason for hiding this comment

Uh oh!

jnquintin Nov 16, 2017

Choose a reason for hiding this comment

Uh oh!

jnquintin Nov 16, 2017

Choose a reason for hiding this comment

Uh oh!

jnquintin Nov 16, 2017

Choose a reason for hiding this comment

Uh oh!

trosh commented Nov 21, 2017

Uh oh!

jnquintin commented Nov 21, 2017

Uh oh!

trosh commented Nov 22, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants