objutils 0.10.9__tar.gz → 0.10.11__tar.gz

objutils-0.10.11/.clang-format

@@ -0,0 +1,206 @@
+---
+Language: Cpp
+AccessModifierOffset: -1
+AlignAfterOpenBracket: BlockIndent
+AlignArrayOfStructures: Left
+AlignConsecutiveMacros: true
+#  Enabled: true
+#  AcrossEmptyLines: true
+#  AcrossComments: true
+AlignConsecutiveAssignments: true
+#  Enabled: true
+#  AcrossEmptyLines: true
+#  AcrossComments: true
+AlignConsecutiveDeclarations: true
+#  Enabled: false
+#  AcrossEmptyLines: true
+#  AcrossComments: true
+AlignConsecutiveBitFields: true
+#  Enabled: false
+#  AcrossEmptyLines: true
+#  AcrossComments: true
+AlignEscapedNewlines: Right
+AlignOperands: Align
+AlignTrailingComments: true
+# Starting with clang-format 16:
+# Kind: Always
+# OverEmptyLines: 2
+# MaxEmptyLinesToKeep: 2
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortEnumsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortLambdasOnASingleLine: Inline
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: Yes
+# AttributeMacros: ['__capability', '__output', '__ununsed']    #  useful for language extensions or static analyzer annotations.
+BinPackArguments: true
+BinPackParameters: true
+BitFieldColonSpacing: After
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterCaseLabel: false
+  AfterClass: false
+  AfterControlStatement: Never
+  AfterEnum: false
+  AfterFunction: false
+  AfterNamespace: false
+  AfterObjCDeclaration: false
+  AfterStruct: false
+  AfterUnion: false
+  AfterExternBlock: false
+  BeforeCatch: false
+  BeforeElse: false
+  IndentBraces: false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+# BracedInitializerIndentWidth: 4
+# BreakAfterAttributes: Never
+BreakAfterJavaFieldAnnotations: true
+BreakBeforeBinaryOperators: None
+# BreakBeforeConceptDeclarations: Allowed
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: AfterComma
+BreakBeforeTernaryOperators: false
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: AfterColon
+BreakStringLiterals: true
+ColumnLimit: 132
+CommentPragmas: "^ IWYU pragma:"
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: false
+DeriveLineEnding: true
+DerivePointerAlignment: true
+DisableFormat: false
+EmptyLineAfterAccessModifier: Always
+EmptyLineBeforeAccessModifier: LogicalBlock
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks: Regroup
+IncludeCategories:
+  - Regex: r'^<ext/.*\.h>'
+    Priority: 2
+    SortPriority: 0
+  - Regex: r'^<.*\.h>'
+    Priority: 1
+    SortPriority: 0
+  - Regex: "^<.*"
+    Priority: 2
+    SortPriority: 0
+  - Regex: ".*"
+    Priority: 3
+    SortPriority: 0
+IncludeIsMainRegex: "([-_](test|unittest))?$"
+IncludeIsMainSourceRegex: ""
+IndentCaseLabels: true
+IndentCaseBlocks: true
+IndentExternBlock: Indent
+IndentGotoLabels: true
+IndentPPDirectives: BeforeHash
+# IndentRequiresClause: true
+IndentWidth: 4
+IndentWrappedFunctionNames: false
+# InsertBraces: true # be careful!
+# InsertNewlineAtEOF: true  # clang-format 16
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: ""
+MacroBlockEnd: ""
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: Inner
+ObjCBinPackProtocolList: Never
+ObjCBlockIndentWidth: 4
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PackConstructorInitializers: NextLine
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PPIndentWidth: 4
+RawStringFormats:
+  - Language: Cpp
+    Delimiters:
+      - cc
+      - CC
+      - cpp
+      - Cpp
+      - CPP
+      - "c++"
+      - "C++"
+    CanonicalDelimiter: ""
+    BasedOnStyle: google
+  - Language: TextProto
+    Delimiters:
+      - pb
+      - PB
+      - proto
+      - PROTO
+    EnclosingFunctions:
+      - EqualsProto
+      - EquivToProto
+      - PARSE_PARTIAL_TEXT_PROTO
+      - PARSE_TEST_PROTO
+      - PARSE_TEXT_PROTO
+      - ParseTextOrDie
+      - ParseTextProtoOrDie
+    CanonicalDelimiter: ""
+    BasedOnStyle: google
+ReferenceAlignment: Left
+ReflowComments: true
+SeparateDefinitionBlocks: Always
+SortIncludes: true
+SortUsingDeclarations: true
+
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: false
+
+SpaceAroundPointerQualifiers: Both
+
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCaseColon: false
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatementsExceptControlMacros
+# SpaceBeforeParensOptions -- TODO:
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceBeforeSquareBrackets: false
+SpacesBeforeTrailingComments: 2
+
+SpacesInAngles: Leave
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: false
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+
+Standard: Auto
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth: 4
+UseCRLF: false
+UseTab: Never

objutils-0.10.11/.codacy.yml

@@ -0,0 +1,17 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+        - python
+  fixme:
+    enabled: true
+  radon:
+    enabled: true
+ratings:
+  paths:
+    - "**.py"
+exclude_paths:
+  - "pyxcp/tests/**.py"
+  - "docs/**py"

objutils-0.10.11/.codeclimate.yml

@@ -0,0 +1,45 @@
+engines:
+  fixme:
+    enabled: true
+  pep8:
+    enabled: false
+  radon:
+    enabled: true
+ratings:
+  paths:
+    - "**.py"
+
+checks:
+  argument-count:
+    config:
+      threshold: 6
+  complex-logic:
+    config:
+      threshold: 4
+  file-lines:
+    config:
+      threshold: 1250
+  method-complexity:
+    config:
+      threshold: 50
+  method-count:
+    config:
+      threshold: 80
+  method-lines:
+    config:
+      threshold: 35
+  nested-control-flow:
+    config:
+      threshold: 4
+  return-statements:
+    config:
+      threshold: 4
+  similar-code:
+    config:
+      threshold: 125 # language-specific defaults. an override will affect all languages.
+  identical-code:
+    config:
+      threshold: 50 # language-specific defaults. an override will affect all languages.
+
+exclude_patterns:
+  - "objutils/tests/**"

objutils-0.10.11/.coveralls.yml

@@ -0,0 +1,2 @@
+repo_token: zEwGv7JfVMNIuflBJOByoV9wLk5Fv1JHO
+service_name: travis-ci

objutils-0.10.11/.github/FUNDING.yml

@@ -0,0 +1 @@
+ko_fi: christoph2

objutils-0.10.11/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,160 @@
+name: Bug Report
+description: Report a bug or unexpected behavior in objutils
+title: "[BUG] "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug! Please fill out the information below to help us diagnose the issue.
+
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of what the bug is.
+      placeholder: When I try to..., I expect... but instead...
+    validations:
+      required: true
+
+  - type: dropdown
+    id: area
+    attributes:
+      label: Area
+      description: Which part of objutils is affected?
+      options:
+        - Hex file readers/writers (ihex, srec, titxt, ...)
+        - ELF / DWARF
+        - PE/COFF / PDB
+        - Registry / High-level API
+        - CLI / Scripts
+        - Installation / Build
+        - Documentation
+        - Performance
+        - Other
+    validations:
+      required: true
+
+  - type: dropdown
+    id: format
+    attributes:
+      label: Format / Module (if applicable)
+      description: Which file format or module is involved?
+      options:
+        - Intel HEX (ihex)
+        - Motorola S-Record (srec)
+        - TI-TXT (titxt)
+        - ELF / DWARF
+        - PE/COFF
+        - PDB
+        - Other / Unknown
+    validations:
+      required: false
+
+  - type: input
+    id: objutils-version
+    attributes:
+      label: objutils Version
+      description: Which version of objutils are you using?
+      placeholder: "e.g., 1.0.0 or 'installed from git main branch'"
+    validations:
+      required: true
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python Version
+      description: Which Python version are you using?
+      placeholder: "e.g., 3.12.1"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      description: Which OS are you running on?
+      options:
+        - Windows 10
+        - Windows 11
+        - Ubuntu / Debian
+        - Other Linux
+        - macOS
+        - Other
+    validations:
+      required: true
+
+  - type: dropdown
+    id: installation
+    attributes:
+      label: Installation Method
+      description: How did you install objutils?
+      options:
+        - pip install objutils
+        - poetry install
+        - Built from source (pip install .)
+        - Built from source (python build_ext.py)
+        - Other
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: Minimal steps to reproduce the issue
+      placeholder: |
+        1. Create config with...
+        2. Run the following code...
+        3. See error...
+      value: |
+        ```python
+        # Your minimal reproducible example here
+        import objutils
+
+        img = objutils.load("ihex", "input.hex")
+        objutils.dump("srec", "output.srec", img)
+        ```
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened? Include full error messages and stack traces.
+      placeholder: |
+        ERROR:objutils:...
+        Traceback (most recent call last):
+          ...
+    validations:
+      required: true
+
+  - type: textarea
+    id: logs
+    attributes:
+      label: Additional Logs
+      description: Any additional logs, debug output, or context
+      placeholder: Use flag for verbose output if applicable
+      render: text
+
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Checklist
+      description: Please confirm the following
+      options:
+        - label: I have searched existing issues for duplicates
+          required: true
+        - label: I have tested with the latest version of pyxcp
+          required: false
+        - label: I can provide a minimal reproducible example
+          required: false

objutils-0.10.11/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Questions & Discussions
+    url: https://github.com/christoph2/objutils/discussions
+    about: For general questions, use GitHub Discussions instead of opening an issue
+  - name: Documentation
+    url: https://github.com/christoph2/objutils/tree/master/docs
+    about: Check the documentation first - many common questions are answered there
+  - name: Examples
+    url: https://github.com/christoph2/objutils/tree/master/examples
+    about: See working examples for common use cases

objutils-0.10.11/.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,76 @@
+name: Documentation Issue
+description: Report missing, incorrect, or unclear documentation
+title: "[DOCS] "
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Help us improve the objutils documentation! Please describe what's missing or unclear.
+
+  - type: dropdown
+    id: doc-type
+    attributes:
+      label: Documentation Type
+      description: What kind of documentation issue is this?
+      options:
+        - Missing documentation
+        - Incorrect / outdated documentation
+        - Unclear / confusing documentation
+        - Typo / formatting issue
+        - Example needed
+        - API reference missing
+    validations:
+      required: true
+
+  - type: textarea
+    id: location
+    attributes:
+      label: Location
+      description: Where is the documentation issue? (URL, file path, or description)
+      placeholder: |
+        e.g., "docs/README.rst, section on supported formats"
+        or "No documentation exists for..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: issue
+    attributes:
+      label: What's Wrong or Missing?
+      description: Describe the documentation issue
+      placeholder: The documentation says... but it should say...
+    validations:
+      required: true
+
+  - type: textarea
+    id: suggestion
+    attributes:
+      label: Suggested Improvement
+      description: If you have a suggestion for how to improve it, please share
+      placeholder: The documentation should explain...
+
+  - type: dropdown
+    id: area
+    attributes:
+      label: Topic Area
+      description: Which topic does this relate to?
+      options:
+        - Getting Started / Installation
+        - Hex File Formats (ihex, srec, titxt, ...)
+        - ELF / DWARF
+        - PE/COFF / PDB
+        - Registry / High-level API
+        - CLI Tools / Scripts
+        - API Reference
+        - Examples / Tutorials
+        - Troubleshooting
+        - Other
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Any other information that might help (screenshots, links, etc.)

objutils-0.10.11/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,90 @@
+name: Feature Request
+description: Suggest a new feature or enhancement for objutils
+title: "[FEATURE] "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for your interest in improving objutils! Please describe the feature you'd like to see.
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem Statement
+      description: Is your feature request related to a problem? Please describe.
+      placeholder: I'm always frustrated when...
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Proposed Solution
+      description: Describe the solution you'd like to see
+      placeholder: I would like to be able to...
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives Considered
+      description: Have you considered any alternative solutions or workarounds?
+      placeholder: I tried... but...
+
+  - type: dropdown
+    id: area
+    attributes:
+      label: Area
+      description: Which area would this feature affect?
+      options:
+        - Hex file readers/writers (ihex, srec, titxt, ...)
+        - ELF / DWARF
+        - PE/COFF / PDB
+        - Registry / High-level API
+        - CLI Tools / Scripts
+        - Documentation
+        - Performance
+        - API Design
+        - Other
+    validations:
+      required: true
+
+  - type: dropdown
+    id: priority
+    attributes:
+      label: Priority (Your Assessment)
+      description: How important is this feature to your use case?
+      options:
+        - Critical - Blocking my work
+        - High - Significantly impacts my workflow
+        - Medium - Would be nice to have
+        - Low - Minor improvement
+    validations:
+      required: true
+
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Add any other context, mockups, code examples, or screenshots about the feature request
+      placeholder: |
+        Example usage:
+        ```python
+        import objutils
+
+        img = objutils.load("ihex", "input.hex")
+        img = objutils.new_feature(img)
+        ```
+
+  - type: checkboxes
+    id: willing
+    attributes:
+      label: Contribution
+      description: Would you be willing to contribute?
+      options:
+        - label: I am willing to submit a pull request for this feature
+          required: false
+        - label: I can help with testing / reviewing
+          required: false

objutils-0.10.11/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1 @@
+If you just have a question, suggestion, or feature-request feel free to ignore the following list :smile:

objutils-0.10.11/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+## Types of changes
+
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] I have read the **CONTRIBUTING** document.
+- [ ] My code follows the code style of this project.
+- [ ] My change requires a change to the documentation.
+- [ ] I have updated the documentation accordingly.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.