Search Results

In the beginning I made this page!

This documentation covers version 3.4.3 What is pyndb? pyndb, short for Python Node Database, is a package which makes it easy to save data to a file while also providing syntactic convenience. It utilizes a Node structure which allows for easily retrieving ...

It's easy To install, you can either install via pip:pip install pyndbOr, you can download the package folder and run:python -m pip install dist/*.whl

How values are represented All keys in a dictionary (loaded from file/object) managed by a PYNDatabase object will be represented as Node objects. Each Node object scans the dictionary it represents, and creates new Nodes for each key. This process repeats re...

To create a new database, first import the PYNDatabase object from the module. Once you have done this, you can initialize it and then store it in a variable. A PYNDatabase object can be initialized with a filename (string), or a dictionary. You can also set t...

If a PYNDatabase object is initialized with a dictionary, it will update the original dictionary object as changes are made. Otherwise, you must call PYNDatabase.save() (unless autosave is set to True). The save method also has a file flag, which allows for ea...

Since values are stored as Node objects, object retrieval will look something like this:PYNDatabase.Node.Node.val val is a variable which contains the value of the Node, and is linked to the original dictionary object. To dynamically retrieve a Node, you can...

If a Node contains itself, a RecursionError will be thrown. See the Structure page for more info. To change the value of a Node, you must use the set method from the parent Node. set will create new values if they don't exist, but this can be changed by sett...

To see if a Node with a specific name(s) is located within a parent, you can use the has method. Command usage: PYNdatabase.has(*names) PYNdatabase.Node.has(*names) If multiple names are entered, True will be returned only if the Node has ALL the names. E...

This function will be replaced with a variable in the future if possible. To view all the children inside a Node, you can call the values method (which is basically a glorified version of the dir command). This command takes no arguments and returns a list.

To delete a Node, you can use the delete method. Command Usage: PYNDatabase.delete(*names) PYNDatabase.Node.delete(*names) If ANY of the names specified do not exist, NONE of them will be deleted.

The transform method places the existing value of a Node into a dictionary under a user-defined key. This way, you can create new Nodes inside your existing one. Command usage: PYNdatabase.transform(name, new_name) PYNdatabase.Node.transform(name, new_name)...

Nodes can only be retrieved with the get method if they contain special characters or numbers (excluding _) Names such as set, get, transform, val, etc. (aka CoreNames) cannot be declared as they are already bound to methods/values that are required in order ...

Some IDEs may throw errors saying that the PYNDatabase class does not have the attribute you requested. Technically, they're not wrong, as it hasn't been created yet. In PyCharm, the fix is simple: enter the context actions menu, and select "Mark all unresolve...

The proper (though not required) filename extension for a PYNDatabase is .pyndb If saving to a JSON file, the prefix .json should be used instead. As of version 3.2.0, pyndb will now automatically set the filetype for you based on the file's extension. The r...

pyndb saves data using pickle by default. pickle is installed with python, and thus should not require installation. Why pickle it? Saving the data to file with pickle allows objects to be saved to file without force injecting a module into pyndb. Here's an...

JSON files are useful when you want your data to be saved as simple, readable, and portable code. This makes it useful in things such as configuration files. JSON files, like plaintext, cannot store objects. To save a PYNDatabase to a JSON file, simply set the...

Plaintext format stores data exactly how you would expect it to - as plain text. What's actually written to the file is the string representation of the fileObj variable. Opening the file will reveal a single line of text being a python dictionary. This is use...

Nodes can be created using the set or create methods. The set method invokes create if the flag create_if_not_exist is set to True. Command Usage: PYNDatabase.create(*names, val=None) PYNDatabase.Node.create(*names, val=None) Although you can create value...

You can use encryption on any file type supported by pyndb. You must have an up-to-date version of the cryptography module to use encryption features. Run "pip -U install cryptography" to update. pyndb allows you to encrypt your databases using Fernet. Encr...