[CASSANDRA-15693] Generating nodetool docs fails with python 3

• Type: Bug
• Status: Resolved
• Priority: Normal
• Resolution: Fixed
• Fix Version/s: 4.0-beta2, 4.0
• Component/s: Build
• Labels: patch
• Bug Category: Code
• Severity: Low
• Complexity: Low Hanging Fruit
• Discovered By: User Report
• Platform: All
• Since Version: 4.0-alpha1

Source Control Link

https://github.com/apache/cassandra/commit/a47be7eddd5855fc7723d4080ca1a63c611efdab

Test and Documentation Plan

Building nodetool docs with the ant target 'gen-doc' fails for python 3. Python 3 doesn't allow the file open mode "rw+".

gen-doc:
     [exec] python convert_yaml_to_rst.py ../conf/cassandra.yaml source/configuration/cassandra_config_file.rst
     [exec] python gen-nodetool-docs.py
     [exec] Makefile:64: recipe for target 'html' failed
     [exec] Traceback (most recent call last):
     [exec]   File "gen-nodetool-docs.py", line 75, in <module>
     [exec]     with open(helpfilename, "rw+") as helpfile:
     [exec] ValueError: must have exactly one of create/read/write/append mode
     [exec] make: *** [html] Error 1
     [exec] Result: 2

Fails on and patch 0001-Fix-file-open-modes-for-python-3.patch tested on the following platforms: Ubuntu 18.04.4 LTS with Python 3.6.9 and FreeBSD 12.1-RELEASE-p1 with Python 3.7.7.

• Assignee: Angelo Polo
• Reporter: Angelo Polo

Authors

Angelo Polo

Reviewers

Brandon Williams, Ekaterina Dimitrova

• Created: 04/Apr/20 10:13
• Updated: 03/Jan/21 17:02
• Resolved: 23/Jul/20 22:19

Description

Building nodetool docs with the ant target 'gen-doc' fails for python 3. Python 3 doesn't allow the file open mode "rw+".

gen-doc:
     [exec] python convert_yaml_to_rst.py ../conf/cassandra.yaml source/configuration/cassandra_config_file.rst
     [exec] python gen-nodetool-docs.py
     [exec] Makefile:64: recipe for target 'html' failed
     [exec] Traceback (most recent call last):
     [exec]   File "gen-nodetool-docs.py", line 75, in <module>
     [exec]     with open(helpfilename, "rw+") as helpfile:
     [exec] ValueError: must have exactly one of create/read/write/append mode
     [exec] make: *** [html] Error 1
     [exec] Result: 2

Fails on and patch 0001-Fix-file-open-modes-for-python-3.patch tested on the following platforms: Ubuntu 18.04.4 LTS with Python 3.6.9 and FreeBSD 12.1-RELEASE-p1 with Python 3.7.7.

Issue Links

• relates to: CASSANDRA-15586 4.0 quality testing: Cluster Setup and Maintenance