Skip to content

Improve readability of README, use proper markdown #3

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Improve readability of README, use proper markdown #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
35e0ac5
Improve readability of README, use proper markdown
KjellMorgenstern Jan 19, 2020
f735d9e
Update linux instructions
KjellMorgenstern Jan 19, 2020
30ebd01
Fix: append to "Errors" not "Error"
KjellMorgenstern Jan 19, 2020
a0118e6
Code format and config for local use
KjellMorgenstern Jan 19, 2020
1e7c9c4
Some PEP8 formatting
KjellMorgenstern Jun 21, 2021
2437df5
Update ubuntu instructions, remove python 2.7 notice (not supported a…
KjellMorgenstern Jun 21, 2021
5607ab9
Fix some typos
KjellMorgenstern Jun 21, 2021
2f0a7b8
Be less strict about the file name.
KjellMorgenstern Jun 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
227 changes: 127 additions & 100 deletions FritzingCheckPart.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,39 @@
# (.fzp and .svg) and both check them for correctness and converting xml
# formats (such as CSS style and px on font-size) that Fritzing doesn't support
# in to equivelent xml that Fritzing does support. As well it will convert old
# style white silkscreen images to the new black silkscreen standard.
# style white silkscreen images to the new black silkscreen standard.

# Set Debug to 0 for normal operation (rename the input file and write the
# Set Debug to 0 for normal operation (rename the input file and write the
# pretty printed output to the input file name.
#
# Set Debug to 1 to not rename the input file and write the output to stdout
# rather than the file for debugging but with no debug messages.
#
# Set Debug to 2 to not rename the input file and write the output to stdout
#
# Set Debug to 1 to not rename the input file and write the output to stdout
# rather than the file for debugging but with no debug messages.
#
# Set Debug to 2 to not rename the input file and write the output to stdout
# rather than the file for debugging with debug messages for entry and exit
# from routines.
#
# Set Debug to 3 to not rename the input file and write the output to stdout
# from routines.
#
# Set Debug to 3 to not rename the input file and write the output to stdout
# rather than the file for debugging with verbous debug messages for detail
# debugging.

import logging
import os
import re
import sys

import FritzingTools as Fritzing
import PPTools as PP

Debug = 0

Version = '0.0.2' # Version number of this file.
Version = '0.0.3' # Version number of this file.

# Set up the requested debug level

# Import os and sys to get file rename and the argv stuff, re for regex and
# logging for logging support

import os, sys, re, logging

if Debug == 3:

Expand All @@ -46,18 +53,17 @@
logging.basicConfig(stream=sys.stderr, level=logging.WARNING)

# End of if Debug == 3:

# Import various svg routines and pretty printing routines.

import FritzingTools as Fritzing, PPTools as PP



# Start of the main script

# Set the Errors flag to 'n' to indicate no errors yet.

ErrorsSeen = 'n'

# Create the processed dictionary to keep track of what files have been
# Create the processed dictionary to keep track of what files have been
# processed in a dir dir context to prevent part. type svg files from being
# processed twice (which would destroy the original file as it got backed up
# for the second time). The FzpDict gets reset for each file and thus won't
Expand All @@ -69,18 +75,20 @@

Errors, Warnings, Info, FzpDict, CurView, TagStack, State, InheritedAttributes = Fritzing.InitializeAll()

# PrefixDir needs to be global even between files, so reset it once here.
# PrefixDir needs to be global even between files, so reset it once here.

PrefixDir = None

FileType, DirProcessing, PrefixDir, Path, File, SrcDir, DstDir = Fritzing.ProcessArgs (sys.argv, Errors)
FileType, DirProcessing, PrefixDir, Path, File, SrcDir, DstDir = Fritzing.ProcessArgs(
sys.argv, Errors)

logging.debug (' FritzingCheckPart.py FileType %s, DirProcessing %s PrefixDir %s, Path %s, File %s, SrcDir %s, DstDir %s\n', FileType, DirProcessing, PrefixDir, Path, File, SrcDir, DstDir)
logging.debug(
' FritzingCheckPart.py FileType %s, DirProcessing %s PrefixDir %s, Path %s, File %s, SrcDir %s, DstDir %s\n',
FileType, DirProcessing, PrefixDir, Path, File, SrcDir, DstDir)

# If the returned FileType is None then go print the errors then exit.

if FileType == None:

if FileType == None:
PP.PrintErrors(Errors)

sys.exit(1)
Expand All @@ -104,24 +112,24 @@
if DirProcessing == 'Y':

# The input is two directories (src and dst), so process the files in src
# directory one at a time and write the results to the dst directory.
# There are three cases, One: a directory of svg files only, which will
# be processed and written to the dst directory (although the empty
# directories for the svg files will be there as well) Two: a fzp file
# where first the fzp file will be processed, and then its associated
# directory one at a time and write the results to the dst directory.
# There are three cases, One: a directory of svg files only, which will
# be processed and written to the dst directory (although the empty
# directories for the svg files will be there as well) Two: a fzp file
# where first the fzp file will be processed, and then its associated
# svg files will be processed (with data from the fzp file to check against
# the svg data) and written in to the corresponding directories under the
# dst directory. Three: a part.filename.fzp which will be processed in to
# the dst directory, and then its associated svg files which will also be
# processed in to the dst directory (again with the empty svg directories
# the svg data) and written in to the corresponding directories under the
# dst directory. Three: a part.filename.fzp which will be processed in to
# the dst directory, and then its associated svg files which will also be
# processed in to the dst directory (again with the empty svg directories
# being present as well). As the fzp file is processed (and its associated
# svgs) the svg filenames will be added to the FilesProcessed dictionary
# and tested for here so that the svg does not get processed as part of
# the fzp and then again as the individual svg (without the connector
# information from the fzp) to avoid duplication, less information
# (because of no fzp data), confusion and most importantly loss of the
# original input file. Any svg files that aren't referenced by an fzp will
# get processed as svg files though.
# svgs) the svg filenames will be added to the FilesProcessed dictionary
# and tested for here so that the svg does not get processed as part of
# the fzp and then again as the individual svg (without the connector
# information from the fzp) to avoid duplication, less information
# (because of no fzp data), confusion and most importantly loss of the
# original input file. Any svg files that aren't referenced by an fzp will
# get processed as svg files though.

# Then process all the files in the src directory

Expand All @@ -134,11 +142,11 @@
FQOutFile = os.path.join(DstDir, InFile)

# Then get just the file name (no path) for the regexs and the svg
# already processed as part of an fzp check.
# already processed as part of an fzp check.

BaseFile = os.path.basename(FQInFile)

# Determine if this is a part. type file or not.
# Determine if this is a part. type file or not.

if PartRegex.search(BaseFile) or SVgPrefixRegex.search(BaseFile):

Expand All @@ -148,107 +156,119 @@

FzpType = 'FZPFRITZ'

# End of if PartRegex.search(BaseFile) or SVgPrefixRegex.search(BaseFile):
# End of if PartRegex.search(BaseFile) or
# SVgPrefixRegex.search(BaseFile):

logging.debug(
' FritzingCheckPart.py dir loop set FzpType %s\n', FzpType)

logging.debug (' FritzingCheckPart.py dir loop set FzpType %s\n', FzpType)

# Check the dictionary to make sure we haven't already processed this
# svg as part of one of the fzp files we have already processed.
# svg as part of one of the fzp files we have already processed.

logging.debug (' FritzingCheckPart.py dir loop trying FQInFile %s\n', FQInFile)
logging.debug(
' FritzingCheckPart.py dir loop trying FQInFile %s\n', FQInFile)

if not 'processed.' + FQInFile in FilesProcessed:

logging.debug (' FritzingCheckPart.py didn\'t find \"%s\" in FilesProcessed\n', 'processed.' + FQInFile )
logging.debug(
' FritzingCheckPart.py didn\'t find \"%s\" in FilesProcessed\n', 'processed.' + FQInFile)

# We haven't yet processed this file so do so now.
# We haven't yet processed this file so do so now.

# Initialize all the global variables before processing a new file.

Errors, Warnings, Info, FzpDict, CurView, TagStack, State, InheritedAttributes = Fritzing.InitializeAll()

print('\n**** Starting to process file {0:s}'.format(str(InFile)))

if SvgExtRegex.search(BaseFile):

# This looks to be an svg file so process it.
# set the FzpType to None (as dir to dir processing doesn't

# set the FzpType to None (as dir to dir processing doesn't
# require filename translation).

Doc = Fritzing.ProcessSvg(FzpType, 'SVG', FQInFile, FQOutFile, CurView, PrefixDir, Errors, Warnings, Info, FzpDict, FilesProcessed, TagStack, State, InheritedAttributes, Debug)


Doc = Fritzing.ProcessSvg(FzpType, 'SVG', FQInFile, FQOutFile, CurView, PrefixDir, Errors,
Warnings, Info, FzpDict, FilesProcessed, TagStack, State, InheritedAttributes,
Debug)

elif PartRegex.search(BaseFile):

# This looks to be an part.filename.fzp file so process it.
# set the FzpType to 'dir' (as dir to dir processing doesn't

# set the FzpType to 'dir' (as dir to dir processing doesn't
# require filename translation) and FileType to 'fzpPart'.


Doc = Fritzing.ProcessFzp(DirProcessing, FzpType, 'FZPPART', FQInFile, FQOutFile, CurView, PrefixDir, Errors, Warnings, Info, FzpDict, FilesProcessed, TagStack, State, InheritedAttributes, Debug)


Doc = Fritzing.ProcessFzp(DirProcessing, FzpType, 'FZPPART', FQInFile, FQOutFile, CurView, PrefixDir,
Errors, Warnings, Info, FzpDict, FilesProcessed, TagStack, State,
InheritedAttributes, Debug)

elif FzpExtRegex.search(BaseFile):

# This looks to be a filename.fzp file so process it.
# set the FzpType to 'dir' (as dir to dir processing doesn't

# set the FzpType to 'dir' (as dir to dir processing doesn't
# require filename translation) and FileType to 'fzpFritz'.
# We do however need to add the PrefixDir to the output
# We do however need to add the PrefixDir to the output
# filename.

FQOutFile = os.path.join(DstDir, PrefixDir)

FQOutFile = os.path.join(FQOutFile, InFile)

Doc = Fritzing.ProcessFzp(DirProcessing, FzpType, 'FZPFRITZ', FQInFile, FQOutFile, CurView, PrefixDir, Errors, Warnings, Info, FzpDict, FilesProcessed, TagStack, State, InheritedAttributes, Debug)


Doc = Fritzing.ProcessFzp(DirProcessing, FzpType, 'FZPFRITZ', FQInFile, FQOutFile, CurView, PrefixDir,
Errors, Warnings, Info, FzpDict, FilesProcessed, TagStack, State,
InheritedAttributes, Debug)

else:
# Not a fritzing file type so warn about it but otherwise

# Not a fritzing file type so warn about it but otherwise
# ignore it.

Warnings.append('Warning 1: File\n\n\'{0:s}\'\n\nIsn\'t a Fritzing file and has been ignored in processing the directory\n'.format(str(InFile)))


Warnings.append(
'Warning 1: File\n\n\'{0:s}\'\n\nIsn\'t a Fritzing file and has been ignored in processing the directory\n'.format(
str(InFile)))

# End of if SvgExtRegex.search(InFile):

if len(Errors) != 0:

# If we have seen errors in this file, note that to set the
# eventual return code when all processing is done.

# If we have seen errors in this file, note that to set the
# eventual return code when all processing is done.

ErrorsSeen = 'Y'

# End of if len(Errors) != 0:

# Output the Info, Warnings and Errors associated with the document
# before they get cleared for the next file.
# before they get cleared for the next file.

PP.PrintInfo(Info)

PP.PrintWarnings(Warnings)

PP.PrintErrors(Errors)

else:

logging.debug (' FritzingCheckPart.py skipped file %s as already proessed\n', FQInFile)
logging.debug(
' FritzingCheckPart.py skipped file %s as already proessed\n', FQInFile)

# End of if not 'processed.' + FQInFile in FilesProcessed:

# End of for InFile in os.listdir(SrcDir):

elif FileType == 'SVG':

# This looks to be an svg file so process it Create the input file name
# from Path, PrefixDir and File then set the output file to None
# to cause the input file to be moved to .bak and be replaced by the output.
# to cause the input file to be moved to .bak and be replaced by the
# output.

InFile = os.path.join(Path, PrefixDir)

InFile = os.path.join(InFile, File)

# set the FzpType
# set the FzpType

if SVgPrefixRegex.match(File):

Expand All @@ -264,7 +284,8 @@

# End of if SVgPrefixRegex.match(File):

Doc = Fritzing.ProcessSvg(FzpType, FileType, InFile, None, CurView, PrefixDir, Errors, Warnings, Info, FzpDict, FilesProcessed, TagStack, State, InheritedAttributes, Debug)
Doc = Fritzing.ProcessSvg(FzpType, FileType, InFile, None, CurView, PrefixDir, Errors,
Warnings, Info, FzpDict, FilesProcessed, TagStack, State, InheritedAttributes, Debug)

# Output the Info, Warnings and Errors associated with the document

Expand All @@ -278,15 +299,18 @@

# This looks to be an fzpPart file so process it Create the input file name
# from Path, PrefixDir and File then set the output file to None
# to cause the input file to be moved to .bak and be replaced by the output.
# to cause the input file to be moved to .bak and be replaced by the
# output.

InFile = os.path.join(Path, PrefixDir)

InFile = os.path.join(InFile, File)

# set the FzpType to 'fzpPart' by reusing FileType in this call

Doc = Fritzing.ProcessFzp(DirProcessing, FileType, FileType, InFile, None, CurView, PrefixDir, Errors, Warnings, Info, FzpDict, FilesProcessed, TagStack, State, InheritedAttributes, Debug)
Doc = Fritzing.ProcessFzp(DirProcessing, FileType, FileType, InFile, None, CurView, PrefixDir,
Errors, Warnings, Info, FzpDict, FilesProcessed, TagStack, State, InheritedAttributes,
Debug)

# Output the Info, Warnings and Errors associated with the document

Expand All @@ -296,11 +320,12 @@

PP.PrintErrors(Errors)

elif FileType == 'FZPFRITZ':
elif FileType == 'FZPFRITZ':

# This looks to be an fzp file so process it Create the input file name
# from Path, PrefixDir and File then set the output file to None
# to cause the input file to be moved to .bak and be replaced by the output.
# to cause the input file to be moved to .bak and be replaced by the
# output.

InFile = os.path.join(Path, PrefixDir)

Expand All @@ -312,7 +337,9 @@

# Use FileType as the FzpType in this call

Doc = Fritzing.ProcessFzp(DirProcessing, FileType, FileType, InFile, None, CurView, PrefixDir, Errors, Warnings, Info, FzpDict, FilesProcessed, TagStack, State, InheritedAttributes, Debug)
Doc = Fritzing.ProcessFzp(DirProcessing, FileType, FileType, InFile, None, CurView, PrefixDir,
Errors, Warnings, Info, FzpDict, FilesProcessed, TagStack, State, InheritedAttributes,
Debug)

# Output the errors and warnings associated with the document

Expand All @@ -324,12 +351,12 @@

else:

Errors.append('Error 8: Unknown FileType {0:s} (should not occur, software error)\n'.format(str(FileType)))
Errors.append(
'Error 8: Unknown FileType {0:s} (should not occur, software error)\n'.format(str(FileType)))

# End of if FileType == 'dir':

if len(Errors) != 0:

# if there were errors set the flag so we exit non 0

ErrorsSeen = 'y'
Expand Down
Loading