TruxtonChildFileIO - Revision history

Sam: /* Sample */

2024-09-11T18:10:07Z

Sample

Sam: /* Sample */

2024-01-27T19:07:15Z

Sample

Sam: /* Properties */

2023-05-02T22:12:41Z

Properties

Sam: /* Truxton Methods */

2022-10-01T11:08:32Z

Truxton Methods

Sam: /* IOBase Methods */

2022-10-01T10:57:42Z

IOBase Methods

Sam at 14:58, 30 July 2022

2022-07-30T14:58:16Z

Sam: /* IOBase Methods */

2022-07-30T14:55:00Z

IOBase Methods

Sam: /* Sample */

2021-02-09T14:47:58Z

Sample

Sam: /* save() */

2020-12-08T11:38:09Z

save()

Sam: /* Truxton Methods */

2020-07-08T18:43:09Z

Truxton Methods

@@ Line 111: / Line 111: @@
 def add_file(parent_truxton_file, filename):
    child = parent_truxton_file.newchild()
-   child.name = Path(filename).name
+   with open(filename, "rb") as source_file:
-  shutil.copyfileobj(source_file, child)
+    child.name = Path(filename).name
-  source_file.close()
+    shutil.copyfileobj(source_file, child)
    child.save()
    return child
@@ Line 121: / Line 120: @@
 def main():
    t = truxton.create()
-   file = t.getfileid("5ec2a123-74d6-5da7-0653-4e6800000000")
+   with t.getfileid("66e0fd95-aafe-b0a4-dade-fde000000065") as file:
-  child = add_file(file, "C:\decrypts\PlainText.txt")
+    child = add_file(file, "C:/decrypts/PlainText.txt")
 if __name__ == "__main__":
    sys.exit(main())
 </source>

@@ Line 125: / Line 125: @@
 if __name__ == "__main__":
-   main()
+   sys.exit(main())
 </source>

@@ Line 45: / Line 45: @@
 =Properties=
-==<code>accessed: int</code>==
+==<code>accessed: [https://docs.python.org/3/library/datetime.html datetime]</code>==
-When the file was last accessed in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks.
+When the file was last accessed.
 ==<code>attributes: int</code>==
@@ Line 52: / Line 53: @@
 For a Microsoft filesystem, it can be a combination of the [https://docs.microsoft.com/en-us/windows/win32/fileio/file-attribute-constants file attribute flags.]
-==<code>created: int</code>==
+==<code>created: [https://docs.python.org/3/library/datetime.html datetime]</code>==
-When the file was created in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks.
+When the file was created.
 ==<code>diskoffset: int</code>==
@@ Line 71: / Line 73: @@
 The [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the media the child file came from.
-==<code>modified: int</code>==
+==<code>modified: [https://docs.python.org/3/library/datetime.html datetime]</code>==
-When the file was last written in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks.
+When the file was last written.
 ==<code>name: str</code>==

@@ Line 31: / Line 31: @@
 The following methods are also present to make tasks of adding items extracted from a file easier.
-* [[TruxtonChildFileIO_newartifact | newartifact()]]
+* [[TruxtonChildFileIO addnote|addnote()]]
-* [[TruxtonChildFileIO_newchild | newchild()]]
+* [[TruxtonChildFileIO newartifact|newartifact()]]
-* [[TruxtonChildFileIO newcommunication | newcommunication()]]
+* [[TruxtonChildFileIO newchild|newchild()]]
-* [[TruxtonChildFileIO_newevent | newevent()]]
+* [[TruxtonChildFileIO newcommunication|newcommunication()]]
-* [[TruxtonChildFileIO_newexif | newexif()]]
+* [[TruxtonChildFileIO newevent|newevent()]]
-* [[TruxtonChildFileIO_newlocation | newlocation()]]
+* [[TruxtonChildFileIO newexif|newexif()]]
-* [[TruxtonChildFileIO_newrelation | newrelation()]]
+* [[TruxtonChildFileIO newlocation|newlocation()]]
-* [[TruxtonChildFileIO_newurl | newurl()]]
+* [[TruxtonChildFileIO newrelation|newrelation()]]
-* [[TruxtonChildFileIO_newusb | newusb()]]
+* [[TruxtonChildFileIO newurl|newurl()]]
-* [[TruxtonChildFileIO tag | tag()]]
+* [[TruxtonChildFileIO newusb|newusb()]]
 =Properties=

@@ Line 4: / Line 4: @@
 From [https://docs.python.org/3/library/io.html#io.IOBase IOBase] it implements:
-* [https://docs.python.org/3/library/io.html#io.IOBase.close close()]
+* [https://docs.python.org/3/library/io.html#io.IOBase.close close()] - Flush and close this stream
-* [https://docs.python.org/3/library/io.html#io.IOBase.closed closed]
+* [https://docs.python.org/3/library/io.html#io.IOBase.closed closed] - [https://docs.python.org/3/library/constants.html#True True] if the stream is closed
 * [https://docs.python.org/3/library/io.html#io.IOBase.fileno fileno()] - Truxton will return ERROR
-* [https://docs.python.org/3/library/io.html#io.IOBase.flush flush()]
+* [https://docs.python.org/3/library/io.html#io.IOBase.flush flush()] - Flush the write buffers of the stream if applicable
-* [https://docs.python.org/3/library/io.html#io.IOBase.isatty isatty()]
+* [https://docs.python.org/3/library/io.html#io.IOBase.isatty isatty()] - Return [https://docs.python.org/3/library/constants.html#True True] if the stream is interactive
 * [https://docs.python.org/3/library/io.html#io.IOBase.readable readable()] - Truxton always returns [https://docs.python.org/3/library/constants.html#False False]
 * [https://docs.python.org/3/library/io.html#io.IOBase.readline readline()] - Do not use, will return ERROR
@@ Line 14: / Line 14: @@
 * [https://docs.python.org/3/library/io.html#io.IOBase.seek seek()] - Truxton will return ERROR
 * [https://docs.python.org/3/library/io.html#io.IOBase.seekable seekable()] - Truxton always returns [https://docs.python.org/3/library/constants.html#False False]
-* [https://docs.python.org/3/library/io.html#io.IOBase.tell tell()]
+* [https://docs.python.org/3/library/io.html#io.IOBase.tell tell()] - Return the current stream position
-* [https://docs.python.org/3/library/io.html#io.IOBase.truncate truncate()]
+* [https://docs.python.org/3/library/io.html#io.IOBase.truncate truncate()] - Resize the stream
 * [https://docs.python.org/3/library/io.html#io.IOBase.writable writable()] - Truxton always returns [https://docs.python.org/3/library/constants.html#True True]
-* [https://docs.python.org/3/library/io.html#io.IOBase.writelines writelines()]
+* [https://docs.python.org/3/library/io.html#io.IOBase.writelines writelines()] - Write a list of lines to the stream
 =RawIOBase Methods=

@@ Line 44: / Line 44: @@
 =Properties=
-==<code>accessed</code>==
+==<code>accessed: int</code>==
 When the file was last accessed in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks.
-==<code>attributes</code>==
+==<code>attributes: int</code>==
 An integer value representing the attributes of the file.
 For a Microsoft filesystem, it can be a combination of the [https://docs.microsoft.com/en-us/windows/win32/fileio/file-attribute-constants file attribute flags.]
-==<code>created</code>==
+==<code>created: int</code>==
 When the file was created in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks.
-==<code>diskoffset</code>==
+==<code>diskoffset: int</code>==
 The offset, in bytes, of the first byte of the contents of the file on the physical disk.
-==<code>entropy</code>==
+==<code>entropy: float</code>==
-[[Truxton_child_file_get_entropy | Shannon's entropy]] of the contents of the file.
+[[Truxton_child_file_get_entropy|Shannon's entropy]] of the contents of the file.
-==<code>hash</code>==
+==<code>hash: str</code>==
 The [https://en.wikipedia.org/wiki/MD5 MD5] hash of the contents of the file.
-==<code>id</code>==
+==<code>id: str</code>==
 The [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the file record.
-This is valid once <code>save()</code>
+This is valid once <code>save()</code> has been called.
-==<code>mediaid</code>==
+==<code>mediaid: str</code>==
 The [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the media the child file came from.
-==<code>modified</code>==
+==<code>modified: int</code>==
 When the file was last written in [https://docs.microsoft.com/en-us/windows/win32/api/minwinbase/ns-minwinbase-filetime FILETIME] ticks.
-==<code>name</code>==
+==<code>name: str</code>==
 The name of the file.
-==<code>origin</code>==
+==<code>origin: int</code>==
 Where the file came from.
-It should be one of the [[Origin | origin values.]]
+It should be one of the [[Origin|origin values.]]
-==<code>parentid</code>==
+==<code>parentid: str</code>==
 The [https://en.wikipedia.org/wiki/Universally_unique_identifier GUID] of the parent of this file.
-==<code>save()</code>==
+==<code>save() -> true</code>==
 This will commit the information to the <code><nowiki>[</nowiki>[[File Table|File]]<nowiki>]</nowiki></code> table.
 It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error.
-==<code>size</code>==
+==<code>size: int</code>==
 The size, in bytes, of the file.
-==<code>status</code>==
+==<code>status: int</code>==
 The status of the contents of the file.
-It should be one of the [[Content Status | content status values.]]
+It should be one of the [[Content Status|content status values.]]
-==<code>type</code>==
+==<code>type: int</code>==
-The [[File Types Supported | type ]] of the file.
+The [[File Types Supported|type]] of the file.
 =Sample=

@@ Line 99: / Line 99: @@
 =Sample=
 This will retrieve a file from Truxton, print the name and hash as stored in the database then calculate a hash on the contents and print that.
-<syntaxhighlight lang="Python">
+<source lang="Python">
 import truxton
 import shutil
@@ Line 120: / Line 122: @@
 if __name__ == "__main__":
    main()
-</syntaxhighlight>
+</source>