Skip to main content

check-symbols

Command-line utility for checking ELF symbols.

Installation

check-symbols requires Python 3.8 or higher.

pip3 install check-symbols

Usage

check-symbols is a command-line application

usage: check-symbols [-h] [--version] [--check <path>] [--diff <path>]
                     [--include <regex> [<regex> ...]] [--exclude <regex> [<regex> ...]] [<path>]

Exported symbol helper tool for shared library projects

positional arguments:
  <path>                path to the shared library, or a directory containing it (default: discover automatically)

options:
  -h, --help            show this help message and exit
  --version             print the version and exit
  --check <path>        path to a text file containing a list of expected symbols (one per line).
                        use a dash ('-') to read from stdin.
  --diff <path>         compiled executable or shared library expected to consume the symbols
  --include <regex> [<regex> ...]
                        one or more regular expressions to select the listed/checked symbols.
  --exclude <regex> [<regex> ...]
                        one or more regular expressions to exclude from the listed/checked symbols.

v0.1.0 - github.com/marzer/check-symbols

Exit codes

Mode Value Meaning
any -1 A fatal error occurred
any 0 No issues were found
--check 1 Some expected symbols listed in the check file were missing from the shared library
--check 2 Some unexpected symbols not listed in the check file were found in the shared library
--check 3 Both of the above
--diff 1 Some expected symbols imported by the target binary were missing from the shared library

Changelog

v0.1.0 - 2024/06/14

  • First public release 🎉️

Metadata

Release files for check-symbols 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for check-symbols 0.1.0
File Size Uploaded
check_symbols-0.1.0.tar.gz 9.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for check-symbols 0.1.0
File Interpreter ABI Platform
check_symbols-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 20.2 kB

Release files / check_symbols-0.1.0.tar.gz

Download URL check_symbols-0.1.0.tar.gz
Size 9.6 kB
Tags Source
SHA-256 checksum
How to use checksums
78ddd85025b5defe5474e44dd3d8bcf598fb6d0e1e9f2fc1e18efd1e2acb9a60
BLAKE2b-256 checksum
How to use checksums
6c50e20fb8b26e1e3975ae792e63f4f043f62e2c049fcf9cea099bfef1a1322d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Release files / check_symbols-0.1.0-py3-none-any.whl

Download URL check_symbols-0.1.0-py3-none-any.whl
Size 10.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9799def8e88568e77edfaa9620cb019f9eec2ed24cac21e3ddbd93271d2b04fb
BLAKE2b-256 checksum
How to use checksums
cc5da71b246a74cc4479bab0edff0cc6e8f5f7146aa3c250e3e8cb9346e4c9e1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page