fly/flightgear
1
0
Fork 0
Code Activity

nasal_api_doc.py: encoding fixes (mostly)

Browse source 
This allows the script to run fine again (we assume UTF-8 encoding for
the parsed Nasal files). Thanks to Huntley Palmer for the report and a
patch. Fixes: https://sourceforge.net/p/flightgear/codetickets/2788/
This commit is contained in:
Florent Rougon 2023-01-19 17:24:46 +01:00
parent 029ce8f0df
commit 437ebfd272
1 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
scripts/python/nasal_api_doc.py
View file

@ -1,4 +1,4 @@
#!/usr/bin/env python #! /usr/bin/env python3
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# Copyright (C) 2012 Adrian Musceac # Copyright (C) 2012 Adrian Musceac
@ -24,7 +24,7 @@ import re, string
"""Script which generates an API documentation file for Nasal libraries """Script which generates an API documentation file for Nasal libraries
located inside $FGROOT/Nasal/ located inside $FGROOT/Nasal/
Usage: nasal_api_doc.py parse [path to $FGROOT/Nasal/] Usage: nasal_api_doc.py parse [path to $FGROOT/Nasal/]
Or configure the local path below, and ommit the path in the console. Or configure the local path below, and omit the path argument in the command.
The API doc in HTML format is generated in the current working directory""" The API doc in HTML format is generated in the current working directory"""
########### Local $FGROOT/Nasal/ path ########## ########### Local $FGROOT/Nasal/ path ##########
@ -41,11 +41,8 @@ def get_files(nasal_dir):
sys.exit() sys.exit()
fgroot_dir = nasal_dir.rstrip('/').replace('Nasal','') fgroot_dir = nasal_dir.rstrip('/').replace('Nasal','')
try: with open(fgroot_dir + 'version', 'r', encoding="utf-8") as f_version:
f_version = open(fgroot_dir+'version','rb') version = f_version.read().strip()
version = f_version.read(256).rstrip('\n')
finally:
f_version.close()
top_level = [] top_level = []
modules = [] modules = []
@ -77,8 +74,12 @@ def get_files(nasal_dir):
output_text(top_namespaces,modules,version) output_text(top_namespaces,modules,version)
def output_text(top_namespaces,modules,version): def output_text(top_namespaces, modules, version):
fw=open('./nasal_api_doc.html','wb') with open('./nasal_api_doc.html', 'w', encoding="utf-8") as fw:
output_text_aux(fw, top_namespaces, modules, version)
def output_text_aux(fw, top_namespaces, modules, version):
buf='<html><head>\ buf='<html><head>\
<title>Nasal API</title>\ <title>Nasal API</title>\
<style>\n\ <style>\n\
@ -148,10 +149,10 @@ def output_text(top_namespaces,modules,version):
buf+='</div>\n' buf+='</div>\n'
buf+='</body></html>' buf+='</body></html>'
fw.write(buf) fw.write(buf)
fw.close()
def parse_file(filename): def parse_file(filename):
with open(filename,'rb') as fr: with open(filename, 'r', encoding="utf-8") as fr:
content = fr.readlines() content = fr.readlines()
i=0 i=0