Skip to main content

Restructure dictionary values by key

Project description

Dictionary Restructure Tool

Project

This project implements in Python a function called restructure():

def restructure(data: dict, specification: dict):
	...

It is useful to restructure where keys are in a dictionary, for example to upgrade a configuration file to a new schema.

Usage

from restructure import restructure

Moving Keys

To move a nested dictionary to the top-level:

input_data = {
	'key1': {
		'key2': {
			'key3': 'value',
		},
	},
}
specification = {
	'key1.key2.key3': 'key',
}

output = restructure(input_data, specification)

assert output == {
	'key': 'value',
}

or the opposite:

input_data = {
	'key': 'value',
}
specification = {
	'key': 'key1.key2.key3',
}

output = restructure(input_data, specification)

assert output == {
	'key1': {
		'key2': {
			'key3': 'value',
		},
	}
}

Or to swap keys:

input_data = {
	'key1': {
		'key2': 'value1',
	},
	'key3': {
		'key4': 'value2',
	},
}
specification = {
	'key1.key2': 'key3.key4',
	'key3.key4': 'key1.key2',
}

output = restructure(input_data, specification)

assert output == {
	'key1': {
		'key2': 'value2',
	},
	'key3': {
		'key4': 'value1',
	},
}

Copying Keys

Keys can be copied using sets of key-paths:

input_data = {
	'key1': {
		'key2': {
			'key3': 'value1',
		},
	},
}
specification = {
	'key1.key2.key3': {'key1.key2.key3.key4', 'key1.key2.key5', 'key1.key6', 'key7'},
}

output = restructure(input_data, specification)

assert output == {
	'key1': {
		'key2': {
			'key3': {
				'key4': 'value1',
			},
			'key5': 'value1',
		},
		'key6': 'value1',
	},
	'key7': 'value1',
}

Merging Keys

Keys which contain dictionaries or equivalent values can be merged:

input_data = {
	'key1': {
		'key2': {
			'key3': 'value1',
		},
	},
	'key4': {
		'key5': 'value2',
	},
	'key6': 'value1',
}
specification = {
	'key4': 'key1.key2',
	'key6': 'key1.key2.key3',
}

output = restructure(input_data, specification)

assert output == {
	'key1': {
		'key2': {
			'key3': 'value1',
			'key5': 'value2',
		},
	},
}

Removing Keys

Keys can be removed by providing None or an empty string:

input_data = {
	'key1': {
		'key2': 'value1',
		'key3': 'value2',
        'key4': 'value3',
	},
}
specification = {
	'key1.key3': None,
    'key1.key4': '',
}

output = restructure(input_data, specification)

assert output == {
	'key1': {
		'key2': 'value1',
	},
}

For Developers

Testing

To run unit tests, run the following command from the project root directory:

python -m unittest

Packaging

Before packaging, update the version number in pyproject.toml

To package & upload the project, run the following commands from the project root directory:

python -m build
python -m twine upload dist/*

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

restructure-0.2.0.tar.gz (7.4 kB view hashes)

Uploaded Source

Built Distribution

restructure-0.2.0-py3-none-any.whl (6.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page