CSV to Dictionaries: Proper Database for your game!

1000h

Hello!  I am very excited to share with you a bit of code today.  This code is a direct translation of Pananag's tutorial on how to make a database for your game in Blender Game Engine.  This is a very useful piece of code for which my games rely on, and now that I am turning my Blender Game Engine prototype into Godot for its build and distribution capabilities it was necessary that I translate it over. I have taken Pananag's Python code and turned it into Godot Script for your database convenience. Before anything further, here are links to Pananag in order to credit him for this excellent insight on how to organize your databases into dictionaries.  Thank you Pananag for sharing your code. Blender Artists: https://blenderartists.org/forum/showthread.php?302504-Series-Basic-inventory-system-for-the-Blender-Game-Engine Youtube main channel: <a rel="nofollow" target="_blank"><img width="640" alt="" height="385"></a> Creating the database: <a rel="nofollow" target="_blank"><img width="640" alt="" height="385" title="Image: null"></a> ------------------------------------- This code can be used for: Taking your CSV files and making dictionaries within the Godot Engine that are nicely organized -Making databases that have header attributes with corresponding values -Magic databases -Item databases -Character databases -Enemy databases CSV example: [ID, Name, Birthday, Favorite Weapon, Strength Stat] [0001, Henry, July3rd, Swords, 1400] What this code does: The following code takes a .CSV (coma separated value file) and reads each line into an array.  The first (top) line in the .CSV is read as an array of what will be used as the HEADERS I.E. ATTRIBUTES of each COLUMN of the .CSV file. Example: These values are now a dictionary.  The definitions are shown on the next line as '' ( empty strings ) {ID : '', Name : '', Birthday : '', Favorite Weapon : '', Strength Stat : ''} The above dictionary, made from the top line of the .CSV file, will then be added as the definition of each key in a new dictionary made up of the first value of each subsequent line in the .CSV file {0001 : {ID : 0001, Name : Henry, Birthday : July3rd, Favorite Weapon : Swords, Strength Stat : 1400} } {0002 : {ID : 0002, Name : Billydilly, Birthday : December40th, Favorite Weapon : Sponges, Strength Stat : -30} } ETC. <img alt="CSV EXAMPLEpng"> USAGE: print(db_characters[CHAR_ID]['Name']) print(db_items[ITEM_ID]['Price']) print(db_monsters[MONSTER_ID]['Drop_1']) EDIT: *********************************************************************************************************** So we all want to write: for key in database.keys(): print(key.keys()) But this does not work.  The loop recognizes the keys as only strings, and not as the dicts which they represent. In order to loop through the keys of keys like we would like, you have to save each database.csv's first line (header) as a list.  This requires editing the code below, which I will do with comments.  This will also require adding an extra argument to the func. Example:

for item in database_1_headers:

node.set_meta(item,database_1[key][item])

print(node.get_meta(item)

COMMON ERROR: Using different programs to open up the save .csv file can cause formatting differences which will cause problems with how .csv files are read by programs trying to call them with read/write related methods. Notably: Sometimes an extra line is added at the end of a .csv file after editing.  This will cause the code to give an error.  I use Notepad++ and OpenOffice's database program to do my .csv files, and in using the two the extra line is added, so I have to open up Notepad++, delete the extra line and save before running the program.  Of course, this only happens when editing your .CSV and not just randomly. ********************************************************THE CODE****************************************

 WITHOUT INDENTS or comments 

func db_import(csv_file,dict_to_append):#EDITED: In order to loop through keys of keys, EXTRA ARG var file = File.new() file.open(csv_file,file.READ) var pos = 0 #artifact var file_len = file.get_as_text().length() #artifact var is_header = true var  attributes_list =  [] file.seek(0) var temp_dict = {} while !file.eof_reached(): var line = file.get_csv_line() if is_header == true: attributes_list = line for item in attributes_list: #EDITED: In order to loop through keys of keys DICT_HEADERS_LIST.append(item) #EDITED: In order to loop through keys of keys is_header = false else: for i in range(0,attributes_list.size()): temp_dict[attributes_list[i]] = line[i] dict_to_append[line[0]] = temp_dict temp_dict = {} #Edited as of 8/26/2016 print(dict_to_append)

1000h

This is the code with comments and tabs shown:

func db_import(csv_file,dict_to_append,DICT_HEADERS_LIST):#EDITED: In order to loop through keys of keys as noted in the EDITED section of the first post, EXTRA ARG is called DICT_HEADERS_LIST

tab->var file = File.new()  #creates a new Class instance.  A var will store this reference as 'file'. (file is not a string)

tab->file.open(csv_file,file.READ) #the file is read into memory.  The .csv can now be manipulated with File methods.

tab->var is_header = true  #this bool will toggle to false once the while loop has run once.

tab->var  attributes_list =  []  #this list will store the first item of each column of the .csv

tab->file.seek(0)  #this makes sure that the reader's cursor position (an invisible cursor) is at the first character.

tab->var temp_dict = {}  #a temporary dictionary which will only live within a call of this func

tab->while !file.eof_reached():  #this says 'While the reader's invisible cursor is not on the last character in the .csv

tab->tab->var line = file.get_csv_line()  #a variable called line will store an array of all of the Comma Separated Strings on one line of the .csv file

tab->tab->if is_header == true:  #Is the bool is_header true?

tab->tab->tab->attributes_list = line  #yes, it is, so set the pre-made array variable above the while loop to equal the first line (which is also an array) tab->tab->tab->for item in attributes_list: #EDITED: In order to loop through keys of keys #for each item in that array variable, tab->tab->tab->tab->DICT_HEADERS_LIST.append(item) #EDITED: In order to loop through keys of keys #append the list-as-arg with whatever column header is being iterated over. tab->tab->tab->is_header = false  #the above loop will not continue because now is_header is false.  You now have a list of header attributes which will be used as keys to locate the specific values entered below them in the .csv file.

tab->tab->else:  #the header list has been created and is_header is false, so continue below

tab->tab->tab->for i in range(0,attributes_list.size()):  #for each index, from the smallest to largest possible value in the array

tab->tab->tab->tab->temp_dict[attributes_list[i]] = line[i] #create a key in the temp_dict variable that is named some item of the attribute_list i.e. the list of headers. #which header is used is notated by the index.   #this newly created key will be defined i.e. have the value of an item in an array of strings i.e. the array of strings taken from a line in the .csv file.

tab->tab->tab->dict_to_append[line[0]] = temp_dict  #our permanent dictionary which we want to create will have a key that is named to be the first item in every line but the first's first item

tab->tab->tab->temp_dict = {}  #Edited as of 8/26/2016 , temp dict has to be cleared or it will only contain the last value  tab->print(dict_to_append)

Haplotyper

Very nice work. I will be working with this soon. Thanks alot!!

Tchey

As a noob, it's super hard to read.

Can you write you code within

code

Stukita

Hi. I'm new to Godot. This script is a great help! Thanks to 1000h and Pananag's. I also had trouble understanding without indenting. This is retouched to the forum code label version. `func db_import(csv_file,dict_to_append,DICT_HEADERS_LIST): #EDITED: In order to loop through keys of keys as noted in the #EDITED section of the first post, EXTRA ARG is called DICT_HEADERS_LIST var file = File.new() #creates a new Class instance.

A var will store this reference as 'file'. (file is not a string)

file.open(csv_file,file.READ) #the file is read into memory.

The .csv can now be manipulated with File methods.

var is_header = true #this bool will toggle to false once the while loop has run once. var attributes_list = [] #this list will store the first item of each column of the .csv file.seek(0) #this makes sure that the reader's cursor position is at the first character. var temp_dict = {} #a temporary dictionary which will only live within a call of this func. while !file.eof_reached(): #this says 'While the reader's cursor is not on the last character in the .csv var line = file.get_csv_line() #a variable called line will store an array of all of

the Comma Separated Strings on one line of the .csv file

if is_header == true: #Is the bool is_header true? attributes_list = line #yes, it is, so set the pre-made array variable above the while loop

to equal the first line (which is also an array)

for item in attributes_list: #EDITED: In order to loop through keys of keys #for each item in that array variable, DICT_HEADERS_LIST.append(item) #EDITED: In order to loop through keys of keys #append the

list-as-arg with whatever column header is being iterated over.

is_header = false #the above loop will not continue because now is_header is false.

You now have a list of header attributes which will be used as keys to

locate the specific values entered below them in the .csv file.

else: #the header list has been created and is_header is false, so continue below for i in range(0,attributes_list.size()): #for each index, from the smallest to largest possible value in the array temp_dict[attributes_list[i]] = line[i] #create a key in the temp_dict variable that is named some item

of the attribute_list i.e. the list of headers.

#which header is used is notated by the index. #this created key will be defined i.e. have the value of an item in an array of strings

i.e. the array of strings taken from a line in the .csv file.

dict_to_append[line[0]] = temp_dict #our permanent dictionary which we want to create will have a key

that is named to be the first item in every line but the first's first item

temp_dict = {} #Edited as of 8/26/2016 , temp dict has to be cleared or it will only contain the last value print(dict_to_append)`