Skip to content

[WIP] Parsing of command-line arguments is broken #66

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.

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

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 0 additions & 3 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,3 @@ exclude_lines =

# No need to test __repr__
def __repr__

# Python 2/3 compatibility
except ImportError
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: [ "3.7", "3.8", "3.9", "3.10", "3.11", "3.12" ]
python-version: [ "3.9", "3.10", "3.11", "3.12" ]

steps:
- uses: actions/checkout@v4
Expand Down
88 changes: 50 additions & 38 deletions bin/jsonpointer
Original file line number Diff line number Diff line change
@@ -1,59 +1,71 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-


import argparse
import json
import os
import sys

import jsonpointer

parser = argparse.ArgumentParser(
description='Resolve a JSON pointer on JSON files')

# Accept pointer as argument or as file
ptr_group = parser.add_mutually_exclusive_group(required=True)

ptr_group.add_argument('-f', '--pointer-file', type=argparse.FileType('r'),
nargs='?',
help='File containing a JSON pointer expression')

ptr_group.add_argument('POINTER', type=str, nargs='?',
help='A JSON pointer expression')

parser.add_argument('FILE', type=argparse.FileType('r'), nargs='+',
help='Files for which the pointer should be resolved')
parser.add_argument('--indent', type=int, default=None,
help='Indent output by n spaces')
parser.add_argument('-v', '--version', action='version',
version='%(prog)s ' + jsonpointer.__version__)


def main():
# First handle backward compatibility for v1 command line syntax:
# jsonpointer ptr.json file.json
if len(sys.argv) >= 3 and not sys.argv[1].startswith('-'):
# Check if the first argument is a file path
if os.path.isfile(sys.argv[1]):
# Insert -f option before the first argument
sys.argv.insert(1, '-f')

parser = argparse.ArgumentParser(
description='Resolve a JSON pointer on JSON files')

# Use mutually exclusive group for pointer specification
pointer_group = parser.add_mutually_exclusive_group(required=True)
pointer_group.add_argument('-e', '--expression',
help='A JSON pointer expression (e.g. "/foo/bar")')
pointer_group.add_argument('-f', '--pointer-file', metavar='POINTER_FILE',
help='File containing a JSON pointer expression')

parser.add_argument('FILE', type=argparse.FileType('r'), nargs='+',
help='Files for which the pointer should be resolved')
parser.add_argument('--indent', type=int, default=None,
help='Indent output by n spaces')
parser.add_argument('-v', '--version', action='version',
version='%(prog)s ' + jsonpointer.__version__)

args = parser.parse_args()

try:
resolve_files()
resolve_files(args)
except KeyboardInterrupt:
sys.exit(1)


def parse_pointer(args):
if args.POINTER:
ptr = args.POINTER
def resolve_files(args):
"""Resolve a JSON pointer on JSON files"""
# Get pointer from expression or file
if args.expression:
ptr = args.expression
elif args.pointer_file:
ptr = args.pointer_file.read().strip()
try:
with open(args.pointer_file) as f:
content = f.read().strip()
# Handle JSON-encoded strings
if content.startswith('"') and content.endswith('"'):
try:
ptr = json.loads(content)
except json.JSONDecodeError:
ptr = content
else:
ptr = content
except FileNotFoundError:
print(f"Error: Pointer file '{args.pointer_file}' not found", file=sys.stderr)
sys.exit(1)
else:
parser.print_usage()
sys.exit(1)

return ptr


def resolve_files():
""" Resolve a JSON pointer on JSON files """
args = parser.parse_args()

ptr = parse_pointer(args)
sys.exit(1) # This should never happen because the group is required

# Process each file
for f in args.FILE:
doc = json.load(f)
try:
Expand Down
34 changes: 26 additions & 8 deletions doc/commandline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,26 @@ that can be used to resolve a JSON pointers on JSON files.

The program has the following usage ::

usage: jsonpointer [-h] [--indent INDENT] [-v] POINTER FILE [FILE ...]
usage: jsonpointer [-h] (-e EXPRESSION | -f POINTER_FILE) [--indent INDENT]
[-v]
FILE [FILE ...]

Resolve a JSON pointer on JSON files

positional arguments:
POINTER File containing a JSON pointer expression
FILE Files for which the pointer should be resolved
FILE Files for which the pointer should be resolved

optional arguments:
-h, --help show this help message and exit
--indent INDENT Indent output by n spaces
-v, --version show program's version number and exit
options:
-h, --help show this help message and exit
-e EXPRESSION, --expression EXPRESSION
A JSON pointer expression (e.g. "/foo/bar")
-f POINTER_FILE, --pointer-file POINTER_FILE
File containing a JSON pointer expression
--indent INDENT Indent output by n spaces
-v, --version show program's version number and exit

For backward compatibility, if the first argument is a file path, it is treated as
if `-f` was specified, allowing the command to be used as in previous versions.


Example
Expand All @@ -36,7 +44,17 @@ Example
$ cat ptr.json
"/a"

# resolve JSON pointer
# resolve JSON pointer (version 1 compatible syntax)
$ jsonpointer ptr.json a.json b.json
[1, 2, 3]
{"b": [1, 3, 4]}

# resolve with -f option
$ jsonpointer -f ptr.json a.json b.json
[1, 2, 3]
{"b": [1, 3, 4]}

# resolve with -e option for direct expression
$ jsonpointer -e "/a" a.json b.json
[1, 2, 3]
{"b": [1, 3, 4]}
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ python-json-pointer
===================

*python-json-pointer* is a Python library for resolving JSON pointers (`RFC
6901 <http://tools.ietf.org/html/rfc6901>`_). Python 2.7, 3.4+
6901 <http://tools.ietf.org/html/rfc6901>`_). Python 3.9+
and PyPy are supported.

**Contents**
Expand Down
4 changes: 1 addition & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@
'Operating System :: OS Independent',
'Programming Language :: Python',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
'Programming Language :: Python :: 3.11',
Expand All @@ -62,5 +60,5 @@
py_modules=MODULES,
scripts=['bin/jsonpointer'],
classifiers=CLASSIFIERS,
python_requires='>=3.7',
python_requires='>=3.9',
)
49 changes: 17 additions & 32 deletions tests.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-

from __future__ import unicode_literals

import copy
import doctest
import sys
import unittest

import jsonpointer
Expand Down Expand Up @@ -78,45 +75,33 @@ def test_round_trip(self):

def test_str_and_repr(self):
paths = [
("", "", "JsonPointer({u}'')"),
("/foo", "/foo", "JsonPointer({u}'/foo')"),
("/foo/0", "/foo/0", "JsonPointer({u}'/foo/0')"),
("/", "/", "JsonPointer({u}'/')"),
("/a~1b", "/a~1b", "JsonPointer({u}'/a~1b')"),
("/c%d", "/c%d", "JsonPointer({u}'/c%d')"),
("/e^f", "/e^f", "JsonPointer({u}'/e^f')"),
("/g|h", "/g|h", "JsonPointer({u}'/g|h')"),
("/i\\j", "/i\\j", "JsonPointer({u}'/i\\\\j')"),
("/k\"l", "/k\"l", "JsonPointer({u}'/k\"l')"),
("/ ", "/ ", "JsonPointer({u}'/ ')"),
("/m~0n", "/m~0n", "JsonPointer({u}'/m~0n')"),
("", "", "JsonPointer('')"),
("/foo", "/foo", "JsonPointer('/foo')"),
("/foo/0", "/foo/0", "JsonPointer('/foo/0')"),
("/", "/", "JsonPointer('/')"),
("/a~1b", "/a~1b", "JsonPointer('/a~1b')"),
("/c%d", "/c%d", "JsonPointer('/c%d')"),
("/e^f", "/e^f", "JsonPointer('/e^f')"),
("/g|h", "/g|h", "JsonPointer('/g|h')"),
("/i\\j", "/i\\j", "JsonPointer('/i\\\\j')"),
("/k\"l", "/k\"l", "JsonPointer('/k\"l')"),
("/ ", "/ ", "JsonPointer('/ ')"),
("/m~0n", "/m~0n", "JsonPointer('/m~0n')"),
]
for path, ptr_str, ptr_repr in paths:
ptr = JsonPointer(path)
self.assertEqual(path, ptr.path)

if sys.version_info[0] == 2:
u_str = "u"
else:
u_str = ""
self.assertEqual(ptr_str, str(ptr))
self.assertEqual(ptr_repr.format(u=u_str), repr(ptr))

if sys.version_info[0] == 2:
path = "/\xee"
ptr_str = b"/\xee"
ptr_repr = "JsonPointer(u'/\\xee')"
else:
path = "/\xee"
ptr_str = "/\xee"
ptr_repr = "JsonPointer('/\xee')"
self.assertEqual(ptr_repr, repr(ptr))

path = "/\xee"
ptr_str = "/\xee"
ptr_repr = "JsonPointer('/\xee')"
ptr = JsonPointer(path)
self.assertEqual(path, ptr.path)

self.assertEqual(ptr_str, str(ptr))
self.assertEqual(ptr_repr, repr(ptr))

# should not be unicode in Python 2
self.assertIsInstance(str(ptr), str)
self.assertIsInstance(repr(ptr), str)

Expand Down