Adding ability to get ftp & s3 file attributes

HISTORY.rst

@@ -3,6 +3,12 @@ History
 =======
 
 
+v0.9.3 (2020-12-03)
+-----------------------
+
+* Add functions (get_ftp_file_attributes & get_s3_file_attributes) to retrieve metadata on files in FTP and S3.
+
+
 v0.9.2 (2020-12-03)
 -----------------------
 

aioradio/aws/s3.py

@@ -51,6 +51,16 @@ async def list_s3_objects(bucket: str, s3_prefix: str) -> List[str]:
     return arr
 
 
+@AWS_SERVICE.active
+async def get_s3_file_attributes(bucket: str, s3_key: str) -> Dict[str, Any]:
+    '''Get s3 objects metadata attributes.'''
+
+    s3_object = await S3['client']['obj'].get_object(Bucket=bucket, Key=s3_key)
+    del s3_object['Body']
+
+    return s3_object
+
+
 @AWS_SERVICE.active
 async def get_object(bucket: str, s3_key: str) -> bytes:
     '''Directly download contents of s3 object.'''

aioradio/file_ingestion.py

@@ -234,4 +234,10 @@ async def write_file_to_ftp(
         await sleep(1)
 
     # return file attributes
+    return await get_ftp_file_attributes(conn, service_name, ftp_path)
+
+
+async def get_ftp_file_attributes(conn: SMBConnection, service_name: str, ftp_path: str):
+    '''GET FTP file attributes.'''
+
     return conn.getAttributes(service_name=service_name, path=ftp_path)

aioradio/tests/s3_test.py

@@ -9,6 +9,7 @@
 from aioradio.aws.s3 import delete_s3_object
 from aioradio.aws.s3 import download_file
 from aioradio.aws.s3 import get_object
+from aioradio.aws.s3 import get_s3_file_attributes
 from aioradio.aws.s3 import list_s3_objects
 from aioradio.aws.s3 import upload_file
 
@@ -66,3 +67,10 @@ async def test_get_object():
 
     result = await get_object(bucket=S3_BUCKET, s3_key=f'{S3_PREFIX}/hello_world.txt')
     assert result is not None
+
+
+async def test_get_file_attributes():
+    '''Test retrieving s3 object attributes.'''
+
+    result = await get_s3_file_attributes(bucket=S3_BUCKET, s3_key=f'{S3_PREFIX}/hello_world.txt')
+    assert result['ContentLength'] == 22

setup.py

@@ -6,7 +6,7 @@
     long_description = fileobj.read()
 
 setup(name='aioradio',
-    version='0.9.2',
+    version='0.9.3',
     description='Generic asynchronous i/o python utilities for AWS services (SQS, S3, DynamoDB, Secrets Manager), Redis, MSSQL (pyodbc), JIRA and more',
     long_description=long_description,
     long_description_content_type="text/markdown",