Python Everything SDK Example

Plug-in and third party software discussion.
Post Reply
void
Developer
Posts: 15096
Joined: Fri Oct 16, 2009 11:31 pm

Python Everything SDK Example

Post by void »

Everything SDK:
https://www.voidtools.com/support/everything/sdk

test.py:

Code: Select all

import ctypes
import datetime
import struct

#defines
EVERYTHING_REQUEST_FILE_NAME = 0x00000001
EVERYTHING_REQUEST_PATH = 0x00000002
EVERYTHING_REQUEST_FULL_PATH_AND_FILE_NAME = 0x00000004
EVERYTHING_REQUEST_EXTENSION = 0x00000008
EVERYTHING_REQUEST_SIZE = 0x00000010
EVERYTHING_REQUEST_DATE_CREATED = 0x00000020
EVERYTHING_REQUEST_DATE_MODIFIED = 0x00000040
EVERYTHING_REQUEST_DATE_ACCESSED = 0x00000080
EVERYTHING_REQUEST_ATTRIBUTES = 0x00000100
EVERYTHING_REQUEST_FILE_LIST_FILE_NAME = 0x00000200
EVERYTHING_REQUEST_RUN_COUNT = 0x00000400
EVERYTHING_REQUEST_DATE_RUN = 0x00000800
EVERYTHING_REQUEST_DATE_RECENTLY_CHANGED = 0x00001000
EVERYTHING_REQUEST_HIGHLIGHTED_FILE_NAME = 0x00002000
EVERYTHING_REQUEST_HIGHLIGHTED_PATH = 0x00004000
EVERYTHING_REQUEST_HIGHLIGHTED_FULL_PATH_AND_FILE_NAME = 0x00008000

#dll imports
everything_dll = ctypes.WinDLL ("C:\\EverythingSDK\\DLL\\Everything32.dll")
everything_dll.Everything_GetResultDateModified.argtypes = [ctypes.c_int,ctypes.POINTER(ctypes.c_ulonglong)]
everything_dll.Everything_GetResultSize.argtypes = [ctypes.c_int,ctypes.POINTER(ctypes.c_ulonglong)]

#setup search
everything_dll.Everything_SetSearchW("test.py")
everything_dll.Everything_SetRequestFlags(EVERYTHING_REQUEST_FILE_NAME | EVERYTHING_REQUEST_PATH | EVERYTHING_REQUEST_SIZE | EVERYTHING_REQUEST_DATE_MODIFIED)

#execute the query
everything_dll.Everything_QueryW(1)

#get the number of results
num_results = everything_dll.Everything_GetNumResults()

#show the number of results
print("Result Count: {}".format(num_results))

#convert a windows FILETIME to a python datetime
#https://stackoverflow.com/questions/39481221/convert-datetime-back-to-windows-64-bit-filetime
WINDOWS_TICKS = int(1/10**-7)  # 10,000,000 (100 nanoseconds or .1 microseconds)
WINDOWS_EPOCH = datetime.datetime.strptime('1601-01-01 00:00:00',
                                           '%Y-%m-%d %H:%M:%S')
POSIX_EPOCH = datetime.datetime.strptime('1970-01-01 00:00:00',
                                         '%Y-%m-%d %H:%M:%S')
EPOCH_DIFF = (POSIX_EPOCH - WINDOWS_EPOCH).total_seconds()  # 11644473600.0
WINDOWS_TICKS_TO_POSIX_EPOCH = EPOCH_DIFF * WINDOWS_TICKS  # 116444736000000000.0

def get_time(filetime):
    """Convert windows filetime winticks to python datetime.datetime."""
    winticks = struct.unpack('<Q', filetime)[0]
    microsecs = (winticks - WINDOWS_TICKS_TO_POSIX_EPOCH) / WINDOWS_TICKS
    return datetime.datetime.fromtimestamp(microsecs)

#create buffers
filename = ctypes.create_unicode_buffer(260)
date_modified_filetime = ctypes.c_ulonglong(1)
file_size = ctypes.c_ulonglong(1)

#show results
for i in range(num_results):

	everything_dll.Everything_GetResultFullPathNameW(i,filename,260)
	everything_dll.Everything_GetResultDateModified(i,date_modified_filetime)
	everything_dll.Everything_GetResultSize(i,file_size)
	print("Filename: {}\nDate Modified: {}\nSize: {} bytes\n".format(ctypes.wstring_at(filename),get_time(date_modified_filetime),file_size.value))
Please adjust C:\\EverythingSDK\\DLL\\Everything32.dll to your Everything32.dll path (please make sure to esacpe \ with \\).

Output:

Code: Select all

Filename: C:\Users\python\Desktop\test.py
Date Modified: 2019-06-30 19:38:03.171133
Size: 2976 bytes
https://stackoverflow.com/questions/252417/how-can-i-use-a-dll-file-from-python
https://stackoverflow.com/questions/39481221/convert-datetime-back-to-windows-64-bit-filetime
https://stackoverflow.com/questions/2330587/how-to-convert-ctypes-c-long-to-pythons-int
https://stackoverflow.com/questions/45178140/returning-string-from-c-function-with-ctypes-gives-large-int-not-char-pointer
Gisle Vanem
Posts: 34
Joined: Mon May 04, 2015 10:30 am

Re: Python Everything SDK Example

Post by Gisle Vanem »

Your test.py works fine in my Python 3.6.5. But not in Python 2.7.15 !?
Wounder why....
NotNull
Posts: 5167
Joined: Wed May 24, 2017 9:22 pm

Re: Python Everything SDK Example

Post by NotNull »

Forget about Python 2; it is EOL in about 4 months from now ...

(https://www.ncsc.gov.uk/blog-post/time-to-shed-python-2)
void
Developer
Posts: 15096
Joined: Fri Oct 16, 2009 11:31 pm

Re: Python Everything SDK Example

Post by void »

Is there any error message when using Python 2?
pbannink
Posts: 2
Joined: Wed Jan 22, 2020 10:38 am

Re: Python Everything SDK Example

Post by pbannink »

Is there any way of getting the python SDK to work with 2.7.x?
I'd like to use it in a tool that will run as part of another application with its own python executable which (for now) is still based on 2.7.x so I don't have the option to use 3.x yet.

Thanks.
pbannink
Posts: 2
Joined: Wed Jan 22, 2020 10:38 am

Re: Python Everything SDK Example

Post by pbannink »

After some digging into the differences between python 3 & 2.7 ctypes I found the simple answer to my own question.
All I had to so was replace:

Code: Select all

everything_dll.Everything_SetSearchW("test.py")
with:

Code: Select all

everything_dll.Everything_SetSearchW("test.py".decode('utf-8'))
Since Python 3.x ctypes expects unicode strings instead of byte-strings.

The answer was found here:
https://stackoverflow.com/questions/725 ... on-2-and-3
Post Reply