luafilesystem icon indicating copy to clipboard operation
luafilesystem copied to clipboard

attribute mode

Open justincormack opened this issue 12 years ago • 6 comments

Calling the file type "mode" is a bit odd, as "mode" usually refers to the actual read/write protection. I am working on an luafilesystem compatibility layer for ljsyscall and already have a mode field, so I have called it "filetype" and have a compatibilty fix to return as mode in the lfs layer, as "filetype" seems a bit closer to what this field returns...

justincormack avatar Jan 29 '14 20:01 justincormack

Agree that the name is unfortunate, but the lfs API has been there for a long time, it would break lots of stuff if it was changed. What's being proposed here exactly?

hishamhm avatar Jan 29 '14 20:01 hishamhm

You could add a new (preferred) name, and mark the existing one as deprecated.

justincormack avatar Jan 29 '14 20:01 justincormack

I agree the name is a bit odd and I wouldn't have chosen it myself, but IMO I don't think the change is worth the hassle: people would write code with the new name, and then users with existing installs of lfs are forced to upgrade just because of that one string, but not after some breakage and headscratching (especially in a dynamically typed language, where things fail at runtime, often silently).

hishamhm avatar Jan 29 '14 23:01 hishamhm

Thats why you transition it over a number of versions... the alternative is not to change anything (the other thing thats ugly is the iterator spec for directory traversal which looks like it was developed for an earlier version of Lua and adapted).

The problem is that these older projects (luasocket, luaposix and this one) are copied as APIs by newer stuff too (eg openresty copies the luasocket interface) as models for how Lua interfaces should be. So we should be trying to improve them, and defining a specification.

One model would be that they could change in sync with core language changes, so there could be a release for 5.3 with changes, as people will need to update their code then anyway, as the language does not have full compatibility.

justincormack avatar Feb 04 '14 12:02 justincormack

We should rename 'mode' in lfs 2.0 and leave the old name supported but deprecated. What's the preferred new name, 'filetype' or just 'type'?

mpeterv avatar May 05 '16 12:05 mpeterv

i don't know, but for me, on archlinux, and installed by luarocks, attributes functions doesn't return nothing (mode or not). empty table for file or for directory entry. I find why... i follow the doc, but in fact the doc doesn't said that the option of attribute should be a string: 'mode'. I'm newbie on lua. I think the doc should maybe give options surrounded by '' for be almost clear for everybody.

jerome-diver avatar Jun 21 '17 04:06 jerome-diver