beem.comment¶
-
class
beem.comment.
Comment
(authorperm, full=True, lazy=False, steem_instance=None)¶ Bases:
beem.blockchainobject.BlockchainObject
Read data about a Comment/Post in the chain
Parameters: - authorperm (str) – perm link to post/comment
- steem_instance (steem) – Steem() instance to use when accesing a RPC
-
body
¶
-
category
¶
-
curation_penalty_compensation_SBD
()¶ Returns The required post payout amount after 30 minutes which will compentsate the curation penalty, if voting earlier than 30 minutes
-
delete
(account=None, identifier=None)¶ Delete an existing post/comment
Parameters: - identifier (str) – Identifier for the post to upvote Takes
the form
@author/permlink
- account (str) – Voter to use for voting. (Optional)
If
voter
is not defines, thedefault_account
will be taken or a ValueError will be raised- identifier (str) – Identifier for the post to upvote Takes
the form
-
downvote
(weight=-100, voter=None)¶ Downvote the post
Parameters: - weight (float) – (optional) Weight for posting (-100.0 - +100.0) defaults to -100.0
- voter (str) – (optional) Voting account
-
edit
(body, meta=None, replace=False)¶ Edit an existing post
Parameters: - body (str) – Body of the reply
- meta (json) – JSON meta object that can be attached to the post. (optional)
- replace (bool) – Instead of calculating a diff, replace
the post entirely (defaults to
False
)
-
estimate_curation_SBD
(vote_value_SBD, estimated_value_SBD=None)¶ Estimates curation reward
Parameters: - vote_value_SBD (float) – The vote value in SBD for which the curation should be calculated
- estimated_value_SBD (float) – When set, this value is used for calculate the curation. When not set, the current post value is used.
Returns the author rewards.
Example::
{ 'pending_rewards': True, 'payout_SP': 0.912 STEEM, 'payout_SBD': 3.583 SBD, 'total_payout_SBD': 7.166 SBD }
-
get_beneficiaries_pct
()¶ Returns the sum of all post beneficiaries in percentage
-
get_curation_penalty
(vote_time=None)¶ If post is less than 30 minutes old, it will incur a curation reward penalty.
Parameters: vote_time (datetime) – A vote time can be given and the curation penalty is calculated regarding the given time (default is None) When set to None, the current date is used.
-
get_curation_rewards
(pending_payout_SBD=False, pending_payout_value=None)¶ Returns the curation rewards.
Parameters: - pending_payout_SBD (bool) – If True, the rewards are returned in SBD and not in STEEM (default is False)
- pending_payout_value (float/str) – When not None this value instead of the current value is used for calculating the rewards
pending_rewards is True when the post is younger than 7 days. unclaimed_rewards is the amount of curation_rewards that goes to the author (self-vote or votes within the first 30 minutes). active_votes contains all voter with their curation reward.
Example::
{ 'pending_rewards': True, 'unclaimed_rewards': 0.245 STEEM, 'active_votes': { 'leprechaun': 0.006 STEEM, 'timcliff': 0.186 STEEM, 'st3llar': 0.000 STEEM, 'crokkon': 0.015 STEEM, 'feedyourminnows': 0.003 STEEM, 'isnochys': 0.003 STEEM, 'loshcat': 0.001 STEEM, 'greenorange': 0.000 STEEM, 'qustodian': 0.123 STEEM, 'jpphotography': 0.002 STEEM, 'thinkingmind': 0.001 STEEM, 'oups': 0.006 STEEM, 'mattockfs': 0.001 STEEM, 'holger80': 0.003 STEEM, 'michaelizer': 0.004 STEEM, 'flugschwein': 0.010 STEEM, 'ulisessabeque': 0.000 STEEM, 'hakancelik': 0.002 STEEM, 'sbi2': 0.008 STEEM, 'zcool': 0.000 STEEM, 'steemhq': 0.002 STEEM, 'rowdiya': 0.000 STEEM, 'qurator-tier-1-2': 0.012 STEEM } }
-
get_reblogged_by
(identifier=None)¶ Shows in which blogs this post appears
-
get_rewards
()¶ Returns the total_payout, author_payout and the curator payout in SBD. When the payout is still pending, the estimated payout is given out.
Example::
{ 'total_payout': 9.956 SBD, 'author_payout': 7.166 SBD, 'curator_payout': 2.790 SBD }
-
get_vote_with_curation
(voter=None, raw_data=False, pending_payout_value=None)¶ Returns vote for voter. Returns None, if the voter cannot be found in active_votes.
Parameters: - voter (str) – Voter for which the vote should be returned
- raw_data (bool) – If True, the raw data are returned
- pending_payout_SBD (float/str) – When not None this value instead of the current value is used for calculating the rewards
-
get_votes
()¶ Returns all votes as ActiveVotes object
-
id
¶
-
is_comment
()¶ Retuns True if post is a comment
-
is_main_post
()¶ Retuns True if main post, and False if this is a comment (reply).
-
is_pending
()¶ Return if the payout is pending (the post/comment is younger than 7 days)
-
json
()¶
-
json_metadata
¶
-
parent_permlink
¶
-
permlink
¶
-
refresh
()¶
-
reply
(body, title='', author='', meta=None)¶ Reply to an existing post
Parameters: - body (str) – Body of the reply
- title (str) – Title of the reply post
- author (str) – Author of reply (optional) if not provided
default_user
will be used, if present, else aValueError
will be raised. - meta (json) – JSON meta object that can be attached to the post. (optional)
-
resteem
(identifier=None, account=None)¶ Resteem a post
Parameters: - identifier (str) – post identifier (@<account>/<permlink>)
- account (str) – (optional) the account to allow access
to (defaults to
default_account
)
-
reward
¶ Return the estimated total SBD reward.
-
time_elapsed
()¶ Return a timedelta on how old the post is.
-
title
¶
-
type_id
= 8¶
-
upvote
(weight=100, voter=None)¶ Upvote the post
Parameters: - weight (float) – (optional) Weight for posting (-100.0 - +100.0) defaults to +100.0
- voter (str) – (optional) Voting account
-
vote
(weight, account=None, identifier=None, **kwargs)¶ Vote for a post
Parameters: - identifier (str) – Identifier for the post to upvote Takes
the form
@author/permlink
- weight (float) – Voting weight. Range: -100.0 - +100.0. May not be 0.0
- account (str) – Voter to use for voting. (Optional)
If
voter
is not defines, thedefault_account
will be taken or a ValueError will be raised- identifier (str) – Identifier for the post to upvote Takes
the form
-
class
beem.comment.
RecentByPath
(path='promoted', category=None, steem_instance=None)¶ Bases:
list
Obtain a list of votes for an account
Parameters: - account (str) – Account name
- steem_instance (steem) – Steem() instance to use when accesing a RPC
-
class
beem.comment.
RecentReplies
(author, skip_own=True, steem_instance=None)¶ Bases:
list
Obtain a list of recent replies
Parameters: - author (str) – author
- steem_instance (steem) – Steem() instance to use when accesing a RPC