Articles

commentjson – Add comments in JSON files¶

API Documentation¶

commentjson.loads(text, **kwargs)¶

Deserialize text (a str tai unicode-instanssi, joka sisältää jsondocument with Python tai JavaScript like comments) python-objektille.

parametrit:

  • tekstisarjainen JSON – merkkijono kommenttien kera tai ilman.
  • kwargs – kaikki argumentit, että json.loads hyväksyy.

Raises:

commentjson.JSONLibraryException

Returns:

dict or list.

commentjson.dumps(obj, **kwargs)¶

Serialize obj to a JSON formated str. Hyväksyy samat argumentsas json moduuli stdlibissä.

parametrit:

  • obj – a JSON serialisable Python object.
  • kwargs – kaikki argumentit, että json.dumps hyväksyy.

Raises:

commentjson.JSONLibraryException

Returns str:

serialized string.

commentjson.load(fp, **kwargs)¶

Deserialize fp (a .read ()-supporting file-like object containing aJSON document with Python or JavaScript like comments) to a Python object.

parametrit:

  • fp – a .read ()-supporting file-like object containing a JSONdocument with or without comments.
  • kwargs – kaikki argumentit, että json.lataus hyväksytään.

Raises:

commentjson.JSONLibraryException

Returns:

dict or list.

commentjson.dump(obj, fp, **kwargs)¶

Serialize obj JSON formated stream to FP (a.write()-supporting file-like object). Hyväksyy samat argumentit kuin JSON-moduuli stdlibissä.

parametrit:

  • obj – a JSON serialisable Python object.
  • fp-a .read ()-supporting file-like object containing a JSONdocument with or without comments.
  • kwargs – kaikki argumentit, että json.dump hyväksyy.

Raises:

commentjson.JSONLibraryException

exception commentjson.JSONLibraryException