Skip to content
Snippets Groups Projects
Commit b4595004 authored by Moul's avatar Moul
Browse files

[mod] Fix local blockchain code

and load_local_blockchain example

Remove duplicate license statement
Improve overall comments
Remove duplicate explanation which is in the example
Convert to f-string
parent 6eb45ced
Branches
Tags
No related merge requests found
...@@ -13,35 +13,6 @@ ...@@ -13,35 +13,6 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
Copyright 2014-2020 Vincent Texier <vit@free.fr>
DuniterPy is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
DuniterPy is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
# imports locally stored blockchain in the chunk format
# example usage :
# ```
# from duniterpy.helpers.blockchain import load
# bc = load() # gets blockchain iterator
# b = next(bc) # gets block
# b.number # should return 0
# next(bc).number # should return 1 (and so on)
# ```
import json import json
import pathlib import pathlib
...@@ -66,7 +37,7 @@ class JsonBlockchain: ...@@ -66,7 +37,7 @@ class JsonBlockchain:
"""parse a json chunk file""" """parse a json chunk file"""
with open( with open(
self.folder.joinpath( self.folder.joinpath(
"chunk_" + str(self.current_chunk) + "-" + str(CHUNK_SIZE) + ".json" f"chunk_{str(self.current_chunk)}-{str(CHUNK_SIZE)}.json"
) )
) as f: ) as f:
s = f.read() s = f.read()
......
...@@ -13,37 +13,33 @@ ...@@ -13,37 +13,33 @@
# You should have received a copy of the GNU General Public License # You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>. # along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
Copyright 2014-2020 Vincent Texier <vit@free.fr>
DuniterPy is free software: you can redistribute it and/or modify from duniterpy.helpers.blockchain import load
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
DuniterPy is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License def load_local_blockchain():
along with this program. If not, see <http://www.gnu.org/licenses/>. """
this example lets you load a local copy of
duniter blockchain into duniterpy objects
by default, it looks in:
$HOME/.config/duniter/duniter_default/g1/
""" """
# gets blockchain iterator
bc = load()
# gets block
b = next(bc)
# this example lets you load locally copy of duniter blockchain into duniterpy objects # should return 0
# by default, it searches in ~/.config/duniter/duniter_default/g1/ # you can access all properties of this block through it's duniterpy objects attributes
print(f"first block number is: {b.number}")
from duniterpy.helpers.blockchain import load # should return 1
print(f"second block number is: {next(bc).number}")
# should return 2
print(f"third block number is: {next(bc).number}")
def load_local_blockchain():
bc = load() # gets blockchain iterator
b = next(bc) # gets block
print(f"first block number is: {b.number}") # should return 0
# you can access all properties of this block through it's duniterpy objects attributes
print(f"second block number is: {next(bc).number}") # should return 1
print(f"third block number is: {next(bc).number}") # should return 2
# (and so on) # (and so on)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment